attribute_extras 0.1.4 → 1.0.1

data/lib/attribute_extras.rb

@@ -1,50 +1,54 @@
-require 'attribute_extras/extra_builder'
-require 'attribute_extras/hook_builder'
-require 'attribute_extras/modifier'
-require 'logger'
+# frozen_string_literal: true
 
-# Used for automatic attribute manipulation
+require 'attribute_extras/version'
+
+# Extra macros for auto attribute manipulation.
 module AttributeExtras
+  # Parent class of the various extras.
+  class AttributeExtra < Module
+    attr_reader :name
+
+    def initialize(name, attributes, perform)
+      @name = name
+      define_extra(name, attributes, perform)
+    end
+
+    def included(clazz)
+      clazz.before_validation(name)
+    end
+
+    private
+
+    def define_extra(name, attributes, perform)
+      define_method(name) do
+        attributes.each do |attribute|
+          value = public_send(attribute)
+          public_send(:"#{attribute}=", perform[self, attribute, value])
+        end
+      end
+    end
+  end
 
-  # the registered extras
-  mattr_accessor :extras
-  self.extras = []
+  def self.define_extra(name, &perform)
+    extra = Class.new(AttributeExtra)
+    extra_name = name.to_s.gsub(/(?:\A|_)([a-z])/i) { $1.upcase }.to_sym
 
-  # wrap up configuration options into one block
-  def self.configure(&block)
-    yield self
+    AttributeExtras.const_set(extra_name, extra)
+    ActiveRecord::Base.define_singleton_method(name) do |*attributes|
+      include extra.new(name, attributes, perform)
+    end
   end
 
-  # the logger for attribute extras
-  def self.logger
-    @logger ||= Logger.new($stderr)
+  define_extra :nullify_attributes do |*, value|
+    value.presence
   end
 
-  # register the extra and build the functions
-  def self.register_extra(verb, function, past:, validator:, options: nil)
-    past ||= verb
-    compiled_validator = validator.is_a?(Proc) ? validator : ->(options){ validator }
-    options ||= ->(attribute){ {} }
-
-    extra = ExtraBuilder.new(verb, past, function, compiled_validator, options).build
-    hook = HookBuilder.new(verb, past).build
-
-    self.const_set(:"#{verb.capitalize}Attributes", extra)
-    self.extras << extra
-    ActiveRecord::Base.extend(hook)
+  define_extra :strip_attributes do |*, value|
+    value.is_a?(String) ? value.strip : value
   end
 
-  self.register_extra :nullify, ->(value, options){ value.presence },
-    past: :nullified,
-    validator: { format: { allow_nil: true, without: /\A\s*\z/ } }
-
-  self.register_extra :strip, ->(value, options){ value.is_a?(String) ? value.strip : value },
-    past: :stripped,
-    validator: { format: { without: /\A\s+|\s+\z/ } }
-
-  self.register_extra :truncate, ->(value, options){ value.is_a?(String) ? value[0...options[:limit]] : value },
-    past: :truncated,
-    validator: ->(options){ { length: { maximum: options[:limit] } } },
-    options: ->(attribute){ { limit: self.columns_hash[attribute.to_s].limit } }
-
+  define_extra :truncate_attributes do |record, attribute, value|
+    limit = record.class.columns_hash[attribute.to_s].limit
+    value.is_a?(String) ? value[0...limit] : value
+  end
 end

metadata

@@ -1,116 +1,163 @@
 --- !ruby/object:Gem::Specification
 name: attribute_extras
 version: !ruby/object:Gem::Version
-  version: 0.1.4
-  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors:
-- Kevin Deisz
-autorequire: 
-bindir: bin
+- Kevin Newton
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Builds macros to automatically manipulate your models' attributes.
+        version: '1.4'
+description: 'Builds macros to automatically manipulate your models'' attributes.
+
+  '
 email:
-- info@trialnetworks.com
+- kddnewton@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/attribute_extras/extra_builder.rb
-- lib/attribute_extras/hook_builder.rb
-- lib/attribute_extras/modifier.rb
-- lib/attribute_extras/version.rb
-- lib/attribute_extras.rb
-- MIT-LICENSE
-- Rakefile
+- ".github/dependabot.yml"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
 - README.md
-- test/base_extensions_test.rb
-- test/modifier_test.rb
-- test/nullify_attributes_test.rb
-- test/strip_attributes_test.rb
-- test/test_classes.rb
-- test/test_helper.rb
-- test/truncate_attributes_test.rb
-homepage: https://github.com/drugdev/attribute_extras
+- Rakefile
+- attribute_extras.gemspec
+- bin/console
+- bin/setup
+- lib/attribute_extras.rb
+- lib/attribute_extras/version.rb
+homepage: https://github.com/kddnewton/attribute_extras
 licenses:
 - MIT
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/kddnewton/attribute_extras/issues
+  changelog_uri: https://github.com/kddnewton/attribute_extras/blob/v1.0.1/CHANGELOG.md
+  source_code_uri: https://github.com/kddnewton/attribute_extras
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
 summary: Extra macros for auto attribute manipulation.
-test_files:
-- test/base_extensions_test.rb
-- test/modifier_test.rb
-- test/nullify_attributes_test.rb
-- test/strip_attributes_test.rb
-- test/test_classes.rb
-- test/test_helper.rb
-- test/truncate_attributes_test.rb
+test_files: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2015 DrugDev, Inc.
-
-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/lib/attribute_extras/extra_builder.rb

@@ -1,83 +0,0 @@
-module AttributeExtras
-
-  # Builds a concern that will be included into classes when they call
-  # the macro corresponding to the given verb. For instance, for the verb
-  # :nullify it will build out AttributeExtras::NullifyAttributes, which
-  # can be included into classes to get all of the utility functions.
-  class ExtraBuilder
-
-    # store the given options
-    def initialize(verb, past, function, validator, options)
-      @verb = verb
-      @past = past
-      @function = function
-      @validator = validator
-      @options = options
-    end
-
-    # build the extra
-    def build
-      concern = Module.new
-      concern.module_eval(concern_definition)
-      concern::ClassMethods.module_eval(&utilities_definition)
-      concern
-    end
-
-    private
-
-      # the module definition for the concern
-      def concern_definition
-        <<-RUBY
-          extend ActiveSupport::Concern
-
-          module ClassMethods
-            def inherited_#{@past}_attributes
-              @inherited_#{@past}_attributes ||= begin
-                modifiers = []
-                self.ancestors.each do |ancestor|
-                  break if ancestor == ActiveRecord::Base
-                  if ancestor.respond_to?(:#{@past}_attributes)
-                    modifiers += ancestor.#{@past}_attributes
-                  end
-                end
-                modifiers
-              end
-            end
-
-            def #{@past}_attributes
-              @#{@past}_attributes ||= []
-            end
-          end
-
-          def #{@verb}_attributes
-            set_#{@past}_attributes
-            self.changed? ? self.save : true
-          end
-
-          def #{@verb}_attributes!
-            set_#{@past}_attributes
-            self.changed? ? self.save : true
-          end
-
-          private
-
-            def set_#{@past}_attributes
-              self.class.inherited_#{@past}_attributes.each do |modifier|
-                attribute = modifier.attribute
-                self.send(:\"\#{attribute}=\", self.class.#{@verb}_attribute_extra(self.send(attribute), modifier.options))
-              end
-            end
-        RUBY
-      end
-
-      # the module definition for the utilities
-      def utilities_definition
-        verb, function, validator, options = @verb, @function, @validator, @options
-        proc do
-          define_method(:"#{verb}_attribute_extra", function)
-          define_method(:"#{verb}_validator_for", validator)
-          define_method(:"#{verb}_options_for", options)
-        end
-      end
-  end
-end

data/lib/attribute_extras/hook_builder.rb

@@ -1,56 +0,0 @@
-module AttributeExtras
-
-  # Builds a module that extends ActiveRecord::Base to build the macro
-  # corresponding to the given verb. For instance, for the verb :nullify,
-  # it will build a module that extends AR::Base with the method
-  # :nullify_attributes, which is then used to include the concern from
-  # the ExtraBuilder.
-  class HookBuilder
-
-    # store the given options
-    def initialize(verb, past)
-      @verb = verb
-      @past = past
-    end
-
-    # build the hook
-    def build
-      hook = Module.new
-      hook.module_eval(module_definition)
-      hook
-    end
-
-    private
-
-      # the module definition for the extra
-      def module_definition
-        <<-RUBY
-          def #{@verb}_attributes(*attributes, validator: true, writer: true)
-            if self.table_exists? && (non_attributes = attributes.map(&:to_s) - self.column_names).any?
-              AttributeExtras.logger.warn("Invalid attributes passed to #{@verb}_attributes: \#{non_attributes.join(', ')}")
-              return
-            end
-
-            include ::AttributeExtras::#{@verb.capitalize}Attributes
-
-            attributes.each do |attribute|
-              options = self.#{@verb}_options_for(attribute)
-              modifier = Modifier.new(attribute, options)
-
-              if validator
-                validates attribute, self.#{@verb}_validator_for(modifier.options)
-              end
-
-              if writer
-                define_method("\#{attribute}=") do |value|
-                  write_attribute(attribute, self.class.#{@verb}_attribute_extra(value, modifier.options))
-                end
-              end
-
-              #{@past}_attributes << modifier
-            end
-          end
-        RUBY
-      end
-  end
-end

data/lib/attribute_extras/modifier.rb

@@ -1,19 +0,0 @@
-module AttributeExtras
-
-  # a container for an attribute that has been modified
-  class Modifier
-
-    # the attribute this modifier represents
-    attr_reader :attribute
-
-    # the set of options generated for this attribute
-    attr_reader :options
-
-    # store the given options
-    def initialize(attribute, options = {})
-      @attribute = attribute
-      @options = options
-    end
-
-  end
-end

data/test/base_extensions_test.rb

@@ -1,52 +0,0 @@
-require 'test_helper'
-
-class BaseExtensionsTest < ActiveSupport::TestCase
-
-  def test_nullify_attributes_warns
-    assert_output_matches 'Invalid attributes' do
-      address_class(:nullify_attributes, :first_line, :second_line, :third_line)
-    end
-  end
-
-  def test_nullify_attributes_success
-    klass = address_class(:nullify_attributes, :first_line, :second_line)
-    assert_equal klass.nullified_attributes.map(&:attribute), [:first_line, :second_line]
-  end
-
-  def test_strip_attributes_warns
-    assert_output_matches 'Invalid attributes' do
-      address_class(:strip_attributes, :first_line, :second_line, :third_line)
-    end
-  end
-
-  def test_strip_attributes_success
-    klass = address_class(:strip_attributes, :first_line, :second_line)
-    assert_equal klass.stripped_attributes.map(&:attribute), [:first_line, :second_line]
-  end
-
-  def test_truncate_attributes_success
-    klass = address_class(:truncate_attributes, :first_line, :second_line)
-    assert_equal klass.truncated_attributes.map(&:attribute), [:first_line, :second_line]
-  end
-
-  private
-
-    # returns a newly created address class
-    def address_class(macro, *arguments)
-      Class.new(ActiveRecord::Base) do
-        self.table_name = 'addresses'
-        send(macro, *arguments)
-      end
-    end
-
-    # assert that the output to $stderr matches the expected
-    def assert_output_matches(expected)
-      stderr = $stderr
-      $stderr = StringIO.new
-      AttributeExtras.instance_variable_set(:@logger, Logger.new($stderr))
-      yield
-      assert_match expected, $stderr.string
-    ensure
-      $stderr = stderr
-    end
-end

data/test/modifier_test.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-
-class ModifierTest < ActiveSupport::TestCase
-  def test_modifiers
-    modifier = AttributeExtras::Modifier.new(:name, limit: 255)
-    assert_equal modifier.attribute, :name
-    assert_equal modifier.options, { limit: 255 }
-  end
-end

data/test/nullify_attributes_test.rb

@@ -1,57 +0,0 @@
-require 'test_helper'
-
-class NullifyAttributesTest < ActiveSupport::TestCase
-  def test_nullify_attributes
-    person = Person.new
-    person.set_blank_attributes
-
-    assert person.nullify_attributes
-    person_attributes.each do |attribute|
-      assert_nil person.send(attribute)
-    end
-  end
-
-  def test_nullify_attributes!
-    person = Person.new
-    person.set_blank_attributes
-
-    assert person.nullify_attributes!
-    person_attributes.each do |attribute|
-      assert_nil person.send(attribute)
-    end
-  end
-
-  def test_nullified_attributes_inheritance
-    architect = Architect.new
-    architect.set_blank_attributes
-
-    assert architect.nullify_attributes
-    architect_attributes.each do |attribute|
-      assert_nil architect.send(attribute)
-    end
-  end
-
-  def test_nullified_attributes
-    assert_equal person_attributes, Person.nullified_attributes.map(&:attribute)
-    assert_empty Developer.nullified_attributes.map(&:attribute)
-    assert_equal [:architect_nullified], Architect.nullified_attributes.map(&:attribute)
-  end
-
-  def test_inherited_nullified_attributes
-    assert_equal person_attributes, Person.inherited_nullified_attributes.map(&:attribute)
-    assert_equal person_attributes, Developer.inherited_nullified_attributes.map(&:attribute)
-    assert_equal architect_attributes, Architect.inherited_nullified_attributes.map(&:attribute)
-  end
-
-  private
-
-    # a list of the attributes that are nullified on the architect class
-    def architect_attributes
-      @architect_attributes ||= ([:architect_nullified] + person_attributes)
-    end
-
-    # a list of the attributes that are nullified on the person class
-    def person_attributes
-      @person_attributes ||= [:person_nullified_one, :person_nullified_two, :person_nullified_three, :person_nullified_four]
-    end
-end

data/test/strip_attributes_test.rb

@@ -1,57 +0,0 @@
-require 'test_helper'
-
-class StripAttributesTest < ActiveSupport::TestCase
-  def test_strip_attributes
-    person = Person.new
-    person.set_padded_attributes
-
-    assert person.strip_attributes
-    person_attributes.each do |attribute|
-      assert_equal Person.stripped_value, person.send(attribute)
-    end
-  end
-
-  def test_strip_attributes!
-    person = Person.new
-    person.set_padded_attributes
-
-    assert person.strip_attributes!
-    person_attributes.each do |attribute|
-      assert_equal Person.stripped_value, person.send(attribute)
-    end
-  end
-
-  def test_stripped_attributes_inheritance
-    architect = Architect.new
-    architect.set_padded_attributes
-
-    assert architect.strip_attributes
-    architect_attributes.each do |attribute|
-      assert_equal Architect.stripped_value, architect.send(attribute)
-    end
-  end
-
-  def test_stripped_attributes
-    assert_equal person_attributes, Person.stripped_attributes.map(&:attribute)
-    assert_empty Developer.stripped_attributes.map(&:attribute)
-    assert_equal [:architect_stripped], Architect.stripped_attributes.map(&:attribute)
-  end
-
-  def test_inherited_stripped_attributes
-    assert_equal person_attributes, Person.inherited_stripped_attributes.map(&:attribute)
-    assert_equal person_attributes, Developer.inherited_stripped_attributes.map(&:attribute)
-    assert_equal architect_attributes, Architect.inherited_stripped_attributes.map(&:attribute)
-  end
-
-  private
-
-    # a list of the attributes that are stripped on the architect class
-    def architect_attributes
-      @architect_attributes ||= ([:architect_stripped] + person_attributes)
-    end
-
-    # a list of the attributes that are stripped on the person class
-    def person_attributes
-      @person_attributes ||= [:person_stripped_one, :person_stripped_two, :person_stripped_three, :person_stripped_four]
-    end
-end