Merge pull request #215 from dathere/druf_implementation_patch

changed the druf to be backwards compatible and disabled by default

Author: samibaig

CONFIG.md

@@ -0,0 +1,96 @@
+# DataPusher Plus Configuration
+
+## Optional Features
+
+DataPusher Plus includes some optional features that can be enabled through configuration. These features are disabled by default to ensure compatibility with different CKAN versions.
+
+### IFormRedirect Support
+
+The IFormRedirect interface provides custom redirect behavior after dataset and resource form submissions. This interface is only available in certain CKAN branches and is not yet merged into the main CKAN codebase.
+
+**Note**: IFormRedirect methods are only defined when this feature is enabled, keeping the plugin completely clean when disabled.
+
+**Configuration:**
+```ini
+# Enable IFormRedirect functionality (default: false)
+ckanext.datapusher_plus.enable_form_redirect = true
+```
+
+**What it does:**
+- **Dynamically adds IFormRedirect methods** only when enabled
+- Provides custom redirect URLs after dataset/resource creation or editing
+- Redirects to dataset page after dataset metadata submission
+- Redirects to resource view after resource editing
+- Allows "add another resource" workflow
+- **Works best with DRUF** for complete resource-first workflow
+
+**Requirements:**
+- CKAN version with IFormRedirect interface support
+- If the interface is not available, the feature will be automatically disabled with a warning
+- **Recommended**: Enable together with DRUF for optimal resource-first experience
+
+### DRUF (Dataset Resource Upload First) Support
+
+DRUF allows users to upload resources before creating the dataset metadata, providing a resource-first workflow.
+
+**Configuration:**
+```ini
+# Enable DRUF functionality (default: false)  
+ckanext.datapusher_plus.enable_druf = true
+```
+
+**What it does:**
+- Adds a `/resource-first/new` endpoint
+- Creates a temporary dataset and redirects to resource upload
+- Useful for workflows where users want to upload data files first
+- **Overrides templates**: Modifies "Add Dataset" buttons and form stages to support resource-first workflow
+
+**Template Overrides:**
+When DRUF is enabled, the following templates are overridden:
+- `snippets/add_dataset.html`: Changes "Add Dataset" to redirect to resource upload
+- `package/snippets/package_form.html`: Modifies form stages to show "Add data" first
+- `scheming/package/snippets/package_form.html`: Modifies scheming form stages
+
+**Requirements:**
+- No special CKAN version requirements
+- Works with standard CKAN installations
+- Compatible with ckanext-scheming
+
+## Example Configuration
+
+Add these lines to your CKAN configuration file (e.g., `/etc/ckan/default/ckan.ini`):
+
+```ini
+# Enable DRUF (Dataset Resource Upload First) workflow
+ckanext.datapusher_plus.enable_druf = true
+
+# Enable IFormRedirect for better form redirects (recommended with DRUF)
+ckanext.datapusher_plus.enable_form_redirect = true
+```
+
+**Recommended combinations:**
+- **Standard mode**: Both disabled (default) - maintains standard CKAN behavior
+- **Resource-first workflow**: Both enabled - complete resource-first experience
+- **DRUF only**: Only `enable_druf = true` - resource-first without custom redirects
+
+## Template Organization
+
+DataPusher Plus uses a conditional template loading system to avoid conflicts when optional features are disabled:
+
+- **Base templates** (`templates/`): Always loaded, provides standard DataPusher Plus functionality
+- **DRUF templates** (`templates/druf/`): Only loaded when `enable_druf = true`, overrides default dataset creation workflow
+
+This ensures that when DRUF is disabled, your CKAN installation maintains completely standard behavior without any template modifications.
+
+## Backwards Compatibility
+
+When these features are disabled (default), DataPusher Plus maintains full backwards compatibility with standard CKAN installations. The plugin will automatically detect if required interfaces are available and disable features gracefully if they are not supported.
+
+## Logging
+
+The plugin will log the status of these features:
+- Info messages when features are successfully enabled
+- Warning messages when features are configured but not available
+- Debug messages for DRUF blueprint registration
+
+Check your CKAN logs to verify the status of these optional features.

README.md

@@ -143,11 +143,53 @@ Without an index, it takes 1.3 seconds.
       Ok, that's bad, but what makes it worse is that the old table has been deleted already, and Datapusher doesn't tell you what
       caused the job to fail! YIKES!!!!
 
+## DRUF: Dataset Resource Upload First Workflow
+
+DataPusher+ supports an optional **DRUF (Dataset Resource Upload First)** workflow that allows users to upload data files before creating dataset metadata. This resource-first approach is particularly useful for:
+
+- **Data-driven workflows**: Where the structure and content of the data informs the metadata
+- **Exploratory data publishing**: When you want to examine the data before writing descriptions
+- **Simplified workflows**: Reducing the cognitive load of filling out metadata forms upfront
+
+### How DRUF Works
+
+When DRUF is enabled, the dataset creation workflow is modified:
+
+1. **"Add Dataset" buttons** redirect to a resource upload page instead of the metadata form
+2. **Temporary datasets** are automatically created with placeholder metadata
+3. **Resource upload happens first**, allowing DataPusher+ to analyze the data
+4. **Metadata forms** are enhanced with data-driven suggestions based on the uploaded content
+5. **Form redirects** guide users through a logical resource-first workflow
+
+### Enabling DRUF
+
+- To enable DRUF you need [`DRUF compatable ckan version`](https://github.com/ckan/ckan/tree/7778-iformredirect) 
+- You need to have scheming extension enabled and use the example DRUF compatable schema included in the dp+ extension.
+
+Add the following configuration to your CKAN config file (e.g., `/etc/ckan/default/ckan.ini`):
+
+
+```ini
+# Enable DRUF (Dataset Resource Upload First) workflow
+ckanext.datapusher_plus.enable_druf = true
+ckanext.datapusher_plus.enable_form_redirect = true
+```
+
+
+### Backwards Compatibility
+
+DRUF is completely optional and disabled by default. When disabled:
+- Standard CKAN dataset creation workflow is preserved
+- No template modifications are applied
+- Full backwards compatibility with existing CKAN installations
+
+
 ## Requirements:
 * CKAN 2.10+
 * Python 3.10+
 * tested and developed on Ubuntu 22.04.5
 * [`ckan.datastore.sqlsearch.enabled`](https://docs.ckan.org/en/2.10/maintaining/datastore.html#ckanext.datastore.logic.action.datastore_search_sql) set to `true` if you want to use the `temporal_resolution` and `guess_accrual_periodicity` Formula helpers
+* ckanext-scheming extension
 
 ## Development Installation
 
@@ -259,14 +301,10 @@ Add `datapusher_plus` to the plugins in your CKAN configuration file
 ```ini
 ckan.plugins = <other plugins> datapusher_plus
 ```
-
-**Note on DRUF :**
-DRUF is enabled by default when using `datapusher_plus`. If you wish to **disable** DRUF behavior, ensure that the `scheming_datasets` plugin is listed **before** `datapusher_plus` in the plugin list:
-
 Use a DP+ extended scheming schema:
 
 ```ini
-scheming.dataset_schemas =  ckanext.datapusher_plus:dataset_schema.yaml
+scheming.dataset_schemas =  ckanext.datapusher_plus:dataset-druf.yaml
 ```
 
 Configure DP+ numerous settings. See [config.py](ckanext/datapusher_plus/config.py) for details.

ckanext/datapusher_plus/dataset-druf.yaml

@@ -68,55 +68,14 @@ dataset_fields:
   - field_name: end_date
     label: Automatic Update End Date
     form_snippet: date.html
-    validators: ignore_missing check_end_date
+    validators: ignore_missing 
     help_text: If this dataset has an Update Type of Automatic and Automatic Updates should stop at some point, please indicate the end date at which Automatic Updates should stop. If not, leave this field blank.
     help_inline: true
 
-  - field_name: update_frequency
-    label: Update Frequency
-    #required: True
-    form_include_blank_choice: true
-    preset: select
-    choices:
-      - label: Real-time
-        value: real-time
-      - label: 15 minutes or less
-        value: 15 minutes or less
-      - label: Hourly
-        value: hourly
-      - label: Daily
-        value: daily
-      - label: Weekly
-        value: weekly
-      - label: Monthly
-        value: monthly
-      - label: Quarterly
-        value: quarterly
-      - label: Every 6 months
-        value: every 6 months
-      - label: Annually
-        value: annually
-      - label: As needed
-        value: as needed
-      - label: Never
-        value: never
-      - label: Other
-        value: other
-
   - field_name: next_update
     label: Next Update
     form_snippet: date.html
 
-    field_name: caveats_usage
-    label: Caveats and Usage
-    form_snippet: markdown.html
-    help_text: this help is going to be displayed inline.
-    help_inline: true
-
-  - field_name: tag_string
-    label: Tags
-    preset: tag_string_autocomplete_hidden
-    form_placeholder: eg. economy, mental health, government
 
   - field_name: dpp_suggestions
     label: DPP Suggestions