flexible_filter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8180aedd8cdbd147103800c09ff8336cf4e6af376653ad05b784de28cd22cc1a
+  data.tar.gz: 2f1d33e0440df7c73595a77a8c736d7cf97d850aa1f7d30d972e7830fcbfd234
+SHA512:
+  metadata.gz: 02b4b1286755c8d78feca18cf8cc2fb5954d14056c06a816d439c63699c7cc485b5f34f92fcbfc0a8bc4bb2fdc6682f282a0c57aad523318e3b34176a7d1332c
+  data.tar.gz: 5bb188506b7f9c84e5a8d9144987b24629eebf1c573d2063b04fbe1add9ac2cb0b5adfc0c8e51dcc41cac7b16cb23b2858a1b6760b70c51c592926c0984ce3ef

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Robert Ferney
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# FlexibleFilter
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "flexible_filter"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install flexible_filter
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/flexible_filter_manifest.js

@@ -0,0 +1 @@
+// = link_directory ../stylesheets/flexible_filter .css

data/app/assets/stylesheets/flexible_filter/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/flexible_filter/application_controller.rb

@@ -0,0 +1,4 @@
+module FlexibleFilter
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/decorators/application_decorator.rb

@@ -0,0 +1,8 @@
+class ApplicationDecorator < Draper::Decorator
+  # Define methods for all decorated objects.
+  # Helpers are accessed through `helpers` (aka `h`). For example:
+  #
+  #   def percent_amount
+  #     h.number_to_percentage object.amount, precision: 2
+  #   end
+end

data/app/helpers/flexible_filter/application_helper.rb

@@ -0,0 +1,4 @@
+module FlexibleFilter
+  module ApplicationHelper
+  end
+end

data/app/jobs/flexible_filter/application_job.rb

@@ -0,0 +1,4 @@
+module FlexibleFilter
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/flexible_filter/application_mailer.rb

@@ -0,0 +1,6 @@
+module FlexibleFilter
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/flexible_filter/application_record.rb

@@ -0,0 +1,5 @@
+module FlexibleFilter
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/flexible_filter/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Flexible filter</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "flexible_filter/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/simple_form.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+#
+# Uncomment this and change the path if necessary to include your own
+# components.
+# See https://github.com/heartcombo/simple_form#custom-components to know
+# more about custom components.
+# Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f }
+#
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default, class: :input,
+    hint_class: :field_with_hint, error_class: :field_with_errors, valid_class: :field_without_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input placeholder: "Placeholder"
+    b.use :placeholder
+
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+
+    # Calculates maxlength from length validations for string inputs
+    # and/or database column lengths
+    b.optional :maxlength
+
+    # Calculate minlength from length validations for string inputs
+    b.optional :minlength
+
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+
+    ## Inputs
+    # b.use :input, class: 'input', error_class: 'is-invalid', valid_class: 'is-valid'
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+
+    ## full_messages_for
+    # If you want to display the full error message for the attribute, you can
+    # use the component :full_error, like:
+    #
+    # b.use :full_error, wrap_with: { tag: :span, class: :error }
+  end
+
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for bootstrap config.
+  #   inline: input + label
+  #   nested: label > input
+  config.boolean_style = :nested
+
+  # Default class for buttons
+  config.button_class = 'btn'
+
+  # Method used to tidy up errors. Specify any Rails Array method.
+  # :first lists the first message for each field.
+  # Use :to_sentence to list all errors for each field.
+  # config.error_method = :first
+
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'error_notification'
+
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
+
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span.
+  # config.item_wrapper_tag = :span
+
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  # config.item_wrapper_class = nil
+
+  # How the label text should be generated altogether with the required text.
+  # config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  # config.label_class = nil
+
+  # You can define the default class to be used on forms. Can be overridden
+  # with `html: { :class }`. Defaulting to none.
+  # config.default_form_class = nil
+
+  # You can define which elements should obtain additional classes
+  # config.generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use the native HTML5 validations (novalidate form option).
+  # These validations are enabled in SimpleForm's internal config but disabled by default
+  # in this configuration, which is recommended due to some quirks from different browsers.
+  # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations,
+  # change this configuration to true.
+  config.browser_validations = false
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
+  # Custom wrappers for input types. This should be a hash containing an input
+  # type as key and the wrapper that will be used for all inputs with specified type.
+  # config.wrapper_mappings = { string: :prepend }
+
+  # Namespaces where SimpleForm should look for custom input classes that
+  # override default inputs.
+  # config.custom_inputs_namespaces << "CustomInputs"
+
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+
+  # Default priority for country inputs.
+  # config.country_priority = nil
+
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+
+  # Default class for inputs
+  # config.input_class = nil
+
+  # Define the default class of the input wrapper of the boolean input.
+  config.boolean_label_class = 'checkbox'
+
+  # Defines if the default input wrapper class should be included in radio
+  # collection wrappers.
+  # config.include_default_input_wrapper_class = true
+
+  # Defines which i18n scope will be used in Simple Form.
+  # config.i18n_scope = 'simple_form'
+
+  # Defines validation classes to the input_field. By default it's nil.
+  # config.input_field_valid_class = 'is-valid'
+  # config.input_field_error_class = 'is-invalid'
+end

data/config/locales/simple_form.en.yml

@@ -0,0 +1,31 @@
+en:
+  simple_form:
+    "yes": 'Yes'
+    "no": 'No'
+    required:
+      text: 'required'
+      mark: '*'
+      # You can uncomment the line below if you need to overwrite the whole required html.
+      # When using html, text and mark won't be used.
+      # html: '<abbr title="required">*</abbr>'
+    error_notification:
+      default_message: "Please review the problems below:"
+    # Examples
+    # labels:
+    #   defaults:
+    #     password: 'Password'
+    #   user:
+    #     new:
+    #       email: 'E-mail to sign in.'
+    #     edit:
+    #       email: 'E-mail.'
+    # hints:
+    #   defaults:
+    #     username: 'User name to sign in.'
+    #     password: 'No special characters, please.'
+    # include_blanks:
+    #   defaults:
+    #     age: 'Rather not say'
+    # prompts:
+    #   defaults:
+    #     age: 'Select your age'

data/config/routes.rb

@@ -0,0 +1,2 @@
+FlexibleFilter::Engine.routes.draw do
+end

data/lib/flexible_filter/engine.rb

@@ -0,0 +1,5 @@
+module FlexibleFilter
+  class Engine < ::Rails::Engine
+    isolate_namespace FlexibleFilter
+  end
+end

data/lib/flexible_filter/field/equals.rb

@@ -0,0 +1,14 @@
+
+module FlexibleFilter
+  module Field
+    class Equals < Singular
+      def arel
+        arel_table[field].eq(value)
+      end
+
+      def to_s
+        "#{model_name.singular} #{field} is equal to #{value}"
+      end
+    end
+  end
+end

data/lib/flexible_filter/field/singular.rb

@@ -0,0 +1,16 @@
+
+module FlexibleFilter
+  module Field
+    class Singular
+      attr_reader :model, :field, :value
+
+      def initialize(model, field, value)
+        @model = model
+        @field = field
+        @value = value
+      end
+
+      delegate :arel_table, :model_name, to: :model
+    end
+  end
+end

data/lib/flexible_filter/field.rb

@@ -0,0 +1,8 @@
+
+require_relative "field/singular"
+require_relative "field/equals"
+
+module FlexibleFilter
+  module Field
+  end
+end

data/lib/flexible_filter/reflection/belongs_to.rb

@@ -0,0 +1,19 @@
+class FlexibleFilter::Reflection::BelongsTo
+  attr_reader :reflection
+
+  def initialize(reflection)
+    @reflection = reflection
+  end
+
+  delegate :join_primary_key, :join_foreign_key, to: :reflection
+
+  def primary_table
+    reflection.klass.arel_table
+  end
+
+  def foreign_table
+    reflection.active_record.arel_table
+  end
+
+
+end

data/lib/flexible_filter/version.rb

@@ -0,0 +1,3 @@
+module FlexibleFilter
+  VERSION = "0.0.1"
+end

data/lib/flexible_filter.rb

@@ -0,0 +1,7 @@
+require "flexible_filter/version"
+require "flexible_filter/engine"
+require "flexible_filter/field"
+
+module FlexibleFilter
+  # Your code goes here...
+end

data/lib/tasks/flexible_filter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :flexible_filter do
+#   # Task goes here
+# end

data/lib/templates/erb/scaffold/_form.html.erb

@@ -0,0 +1,15 @@
+<%# frozen_string_literal: true %>
+<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= f.error_notification %>
+  <%%= f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present? %>
+
+  <div class="form-inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="form-actions">
+    <%%= f.button :submit %>
+  </div>
+<%% end %>

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: flexible_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Ferney
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+description:
+email:
+- rob@ferney.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/flexible_filter_manifest.js
+- app/assets/stylesheets/flexible_filter/application.css
+- app/controllers/flexible_filter/application_controller.rb
+- app/decorators/application_decorator.rb
+- app/helpers/flexible_filter/application_helper.rb
+- app/jobs/flexible_filter/application_job.rb
+- app/mailers/flexible_filter/application_mailer.rb
+- app/models/flexible_filter/application_record.rb
+- app/views/layouts/flexible_filter/application.html.erb
+- config/initializers/simple_form.rb
+- config/locales/simple_form.en.yml
+- config/routes.rb
+- lib/flexible_filter.rb
+- lib/flexible_filter/engine.rb
+- lib/flexible_filter/field.rb
+- lib/flexible_filter/field/equals.rb
+- lib/flexible_filter/field/singular.rb
+- lib/flexible_filter/reflection/belongs_to.rb
+- lib/flexible_filter/version.rb
+- lib/tasks/flexible_filter_tasks.rake
+- lib/templates/erb/scaffold/_form.html.erb
+homepage: https://github.com/capnregex/flexible_filter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/capnregex/flexible_filter
+  source_code_uri: https://github.com/capnregex/flexible_filter
+  changelog_uri: https://github.com/capnregex/flexible_filter/releases/tag/v0.0.1
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.15
+signing_key:
+specification_version: 4
+summary: Provides An interface for more flexible user specified filtering
+test_files: []