scopiform 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1434c2a39865b2f08dcb918354dad1523cd53d9aa8363f4a699fbcb9ddec537c
-  data.tar.gz: 7930cc5a93d5f71dfe6e3ced466b3d39b2d68730b65528e2630febbeb8b5388d
+  metadata.gz: 934151f9380f5ddc631f49bf933feb2a4763c899a47cae97e17dd682931074c2
+  data.tar.gz: 7b11d4ffe28fbc13613932b4b3aad56cd01e3ad76a18c3b90286e652ca80b847
 SHA512:
-  metadata.gz: d67daa8c043e7edaaf459da62baa64108b2554f81867ca0a24d97d52816a2b887aaa93249def97b1650d102d98d42149414f5e6740c4687ac2762c96b0d0001c
-  data.tar.gz: 8b6d543af8a98acf91c5f8d0c4de23a812c40b0304c755412427d860d4ab7ab9baabbe477ead4d43a16a3eca1c61107012ff9a963688b889d029d8e851302a19
+  metadata.gz: 28c1c3c6a4dadfa6a3a00271fce88c6471c770e0d8249db754f7720ec2f47af6418bf450fd8bf22a85d995190906cc0f833b310081dd9773f8af33fc17fd6e3d
+  data.tar.gz: 726a2fa46e53224a825d55a55d4995198a4458e4a3a12ce54d2d55278cc5a5e04ec8c825682bb6d228207d41810d4bf96d93bf773341e784fa24cf6de8fec637

data/README.md

@@ -24,7 +24,7 @@ $ gem install scopiform
 ## Public ActiveRecord Methods
 :aliases_for
 :apply_filters
-:apply_orders
+:apply_sorts
 :association
 :attribute_aliases_inverted
 :auto_scope_add

data/lib/scopiform/association_scopes.rb

@@ -30,7 +30,7 @@ module Scopiform
       def setup_association_auto_scopes(association)
         auto_scope_add(
           association.name,
-          Proc.new { |value, joins: nil|
+          proc { |value, joins: nil|
             is_root = joins.nil?
             joins = {} if is_root
 
@@ -47,13 +47,13 @@ module Scopiform
           argument_type: :hash
         )
 
-        # Ordering
+        # Sorting
         auto_scope_add(
           association.name,
-          Proc.new { |value| scopiform_joins(association.name).merge(association.klass.apply_orders(value)) },
-          prefix: 'order_by_',
+          proc { |value| scopiform_joins(association.name).merge(association.klass.apply_sorts(value)) },
+          prefix: 'sort_by_',
           argument_type: :hash,
-          type: :order
+          type: :sort
         )
       end
     end

data/lib/scopiform/common_scopes.rb

@@ -21,24 +21,24 @@ module Scopiform
 
           auto_scope_add(
             name,
-            Proc.new { |value| where(name_sym => value) },
+            proc { |value| where(name_sym => value) },
             suffix: '_is',
             argument_type: type
           )
           auto_scope_add(
             name,
-            Proc.new { |value| where.not(name_sym => value) },
+            proc { |value| where.not(name_sym => value) },
             suffix: '_not',
             argument_type: type
           )
 
-          # Ordering
+          # Sorting
           auto_scope_add(
             name,
             ->(value = :asc) { order(name_sym => value) },
-            prefix: 'order_by_',
+            prefix: 'sort_by_',
             argument_type: :string,
-            type: :order
+            type: :sort
           )
         end
       end

data/lib/scopiform/core.rb

@@ -22,12 +22,10 @@ module Scopiform
       end
 
       def auto_scope_add(attribute, block, prefix: nil, suffix: nil, **options)
-        scope_name = "#{prefix}#{attribute}#{suffix}".underscore
-        scope_name_sym = scope_name.to_sym
-        scope scope_name_sym, block
-
         scope_definition = auto_scope_add_definition(attribute, prefix: prefix, suffix: suffix, **options)
 
+        scope scope_definition.name, block
+
         aliases_for(attribute).each do |alias_name|
           auto_scope_for_alias(alias_name, scope_definition)
         end
@@ -41,8 +39,31 @@ module Scopiform
         end
       end
 
+      def enum(definitions)
+        super(definitions)
+
+        definitions.each_key { |name| update_scope_to_enum(name) }
+      end
+
       private
 
+      def update_scope_to_enum(name)
+        scopes = auto_scopes_by_attribute(name)
+
+        scopes.each do |scope|
+          if scope.options[:type].blank?
+            argument_type = scope.options[:argument_type]
+            scope.options[:argument_type] = argument_type.is_a?(Array) ? [:string] : :string if argument_type
+            scope.options[:type] = :enum
+          end
+
+          if scope.options[:remove_for_enum]
+            singleton_class.remove_method scope.name
+            @auto_scopes.delete(scope)
+          end
+        end
+      end
+
       def auto_scope_add_definition(attribute, **options)
         definition = ScopeDefinition.new(attribute, **options)
         @auto_scopes ||= []
@@ -52,10 +73,9 @@ module Scopiform
       end
 
       def auto_scope_for_alias(alias_name, scope_definition)
-        scope_name = "#{scope_definition.prefix}#{scope_definition.attribute}#{scope_definition.suffix}".underscore
-        alias_method_name = "#{scope_definition.prefix}#{alias_name}#{scope_definition.suffix}".underscore
-        singleton_class.send(:alias_method, alias_method_name.to_sym, scope_name.to_sym)
-        auto_scope_add_definition(alias_name, prefix: scope_definition.prefix, suffix: scope_definition.suffix, **scope_definition.options)
+        alias_scope_definition = scope_definition.dup
+        alias_scope_definition.attribute = alias_name
+        singleton_class.send(:alias_method, alias_scope_definition.name, scope_definition.name)
       end
     end
   end

data/lib/scopiform/filters.rb

@@ -11,8 +11,8 @@ module Scopiform
         filters_hash.keys.inject(injecting) { |out, filter_name| resolve_filter(out, filter_name, filters_hash[filter_name], joins) }
       end
 
-      def apply_orders(orders_hash, injecting = all)
-        orders_hash.keys.inject(injecting) { |out, order_name| resolve_order(out, order_name, orders_hash[order_name]) }
+      def apply_sorts(sorts_hash, injecting = all)
+        sorts_hash.keys.inject(injecting) { |out, sort_name| resolve_sort(out, sort_name, sorts_hash[sort_name]) }
       end
 
       private
@@ -31,9 +31,9 @@ module Scopiform
         out.send(filter_name, filter_argument, joins: joins)
       end
 
-      def resolve_order(out, order_name, order_argument)
-        method_name = "order_by_#{order_name}"
-        out.send(method_name, order_argument)
+      def resolve_sort(out, sort_name, sort_argument)
+        method_name = "sort_by_#{sort_name}"
+        out.send(method_name, sort_argument)
       end
     end
   end

data/lib/scopiform/helpers.rb

@@ -51,6 +51,10 @@ module Scopiform
         nil
       end
 
+      def enum_attribute?(name)
+        defined_enums.include? name.to_s
+      end
+
       protected
 
       def safe_columns

data/lib/scopiform/reflection_plugin.rb

@@ -1,9 +1,9 @@
 module Scopiform
   module ReflectionPlugin
-    def add_reflection(ar, name, reflection)
-      super(ar, name, reflection)
+    def add_reflection(record, name, reflection)
+      super(record, name, reflection)
 
-      ar.reflection_added(name, reflection) if ar.respond_to? :reflection_added
+      record.reflection_added(name, reflection) if record.respond_to? :reflection_added
     end
   end
 end

data/lib/scopiform/scope_definition.rb

@@ -10,7 +10,18 @@ module Scopiform
     end
 
     def name
-      "#{prefix}#{attribute}#{suffix}".underscore
+      name_for(attribute)
+    end
+
+    def name_for(attribute_name)
+      "#{prefix}#{attribute}#{suffix}".underscore.to_sym
+    end
+
+    def dup
+      duplicate = super
+      duplicate.options = options.dup
+
+      duplicate
     end
   end
 end

data/lib/scopiform/string_number_date_scopes.rb

@@ -24,42 +24,42 @@ module Scopiform
 
           auto_scope_add(
             name,
-            Proc.new { |value| where(name_sym => value) },
+            proc { |value| where(name_sym => value) },
             suffix: '_in',
             argument_type: [type]
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where.not(name_sym => value) },
+            proc { |value| where.not(name_sym => value) },
             suffix: '_not_in',
             argument_type: [type]
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where(arel_column.lt(value)) },
+            proc { |value| where(arel_column.lt(value)) },
             suffix: '_lt',
             argument_type: type
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where(arel_column.lteq(value)) },
+            proc { |value| where(arel_column.lteq(value)) },
             suffix: '_lte',
             argument_type: type
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where(arel_column.gt(value)) },
+            proc { |value| where(arel_column.gt(value)) },
             suffix: '_gt',
             argument_type: type
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where(arel_column.gteq(value)) },
+            proc { |value| where(arel_column.gteq(value)) },
             suffix: '_gte',
             argument_type: type
           )

data/lib/scopiform/string_number_scopes.rb

@@ -15,7 +15,9 @@ module Scopiform
 
       def setup_string_and_number_auto_scopes
         string_numbers = Helpers::STRING_TYPES + Helpers::NUMBER_TYPES
-        string_number_columns = safe_columns.select { |column| string_numbers.include? column.type }
+        string_number_columns = safe_columns.select do |column|
+          string_numbers.include?(column.type) && !enum_attribute?(column.name)
+        end
         string_number_columns.each do |column|
           name = column.name
           type = column.type
@@ -34,44 +36,50 @@ module Scopiform
 
           auto_scope_add(
             name,
-            Proc.new { |value| where(arel_column.matches("%#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}%")) },
+            proc { |value| where(arel_column.matches("%#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}%")) },
             suffix: '_contains',
-            type: type
+            argument_type: type,
+            remove_for_enum: true
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where.not(arel_column.matches("%#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}%")) },
+            proc { |value| where.not(arel_column.matches("%#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}%")) },
             suffix: '_not_contains',
-            type: type
+            argument_type: type,
+            remove_for_enum: true
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where(arel_column.matches("#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}%")) },
+            proc { |value| where(arel_column.matches("#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}%")) },
             suffix: '_starts_with',
-            type: type
+            argument_type: type,
+            remove_for_enum: true
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where.not(arel_column.matches("#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}%")) },
+            proc { |value| where.not(arel_column.matches("#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}%")) },
             suffix: '_not_starts_with',
-            type: type
+            argument_type: type,
+            remove_for_enum: true
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where(arel_column.matches("%#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}")) },
+            proc { |value| where(arel_column.matches("%#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}")) },
             suffix: '_ends_with',
-            type: type
+            argument_type: type,
+            remove_for_enum: true
           )
 
           auto_scope_add(
             name,
-            Proc.new { |value| where.not(arel_column.matches("%#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}")) },
+            proc { |value| where.not(arel_column.matches("%#{ActiveRecord::Base.sanitize_sql_like(value.to_s)}")) },
             suffix: '_not_ends_with',
-            type: type
+            argument_type: type,
+            remove_for_enum: true
           )
         end
       end

data/lib/scopiform/version.rb

@@ -1,3 +1,3 @@
 module Scopiform
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scopiform
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - jayce.pulsipher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-15 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - jayce.pulsipher@3-form.com