attribute_helpers 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30c3ad3c1054e35f25b381e6ac561ee6af2668a5
-  data.tar.gz: 073eaa8bc7744dab2d6486621a910fb0bf8c869b
+  metadata.gz: 371fc65b415471c2e41907947fd5798831fc912c
+  data.tar.gz: 339b8e18db7b2a4a8458a9b2d7f1043378d9c33f
 SHA512:
-  metadata.gz: 45ea30653a242b3686a1438922daf8ca7328465399260b6cfb5c9b36a2f9d3be19331c8ab7c2cb51040a5775a0f2538e0e028e9a34ad051ca6e142c553b5919c
-  data.tar.gz: d857d77b23a768c48d4c76a18448ad58d04ba47336ef892e5b26df0466eeefbd5779d60e62cc7828614dad7575d865855ca5b1f1b443cc5d2afbd2abb2f2c1de
+  metadata.gz: 98646509854eea74a47cdd40b1bf5e8a7eb966ef4bb75a405718ab9e050809cf112e1f6bc413063e182d298690a8b1159cb82a6e8a706da734900c0eaa349e53
+  data.tar.gz: 72dc5752acf0472e47c9c92fd580a0e5cf2a5b8c95cd3ebe08c4e0c1f29bb1b21c4e133c3536412af87f456234c009fd05344f4a3da19a6965c717002cb498e4

data/.travis.yml

@@ -2,6 +2,9 @@ language: ruby
 rvm:
 - 2.0.0
 - 2.1.4
+- 2.2.0
+before_install:
+  - gem update bundler
 script: bundle exec rspec
 addons:
   code_climate:

data/attribute_helpers.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.1"
   spec.add_development_dependency "rubocop", "~> 0.28"
   spec.add_development_dependency "temping", "~> 3.2"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
 end

data/lib/attribute_helpers.rb

@@ -6,60 +6,49 @@ require "attribute_helpers/version"
 # the database and your application code.
 
 module AttributeHelpers
-  # This module needs to be prepended to work in ActiveRecord classes. This is
-  # because ActiveRecord doesn't have accessors/mutators defined until an
-  # instance is created, which means we need to use the prepend + super()
-  # pattern because attempts to use instance_method + binding will fail since
-  # instance_method will not find the method in the class context as it will not
-  # exist until it is dynamically created when an instance is created. Prepend
-  # works for us because it inserts the behavior *below* the class in the
-  # inheritance hierarchy, so we can access the default ActiveRecord accessors/
-  # mutators through the use of super().
-  # More information here: http://stackoverflow.com/a/4471202/1103543
-  def self.prepended(klass)
-    # We need to store the module in a variable for use when we're in the class
-    # context.
-    me = self
-
-    # Marks attributes as storing symbol values, providing setters and getters
-    # for the attributes that will allow the application to use them as symbols
-    # but store them internally as strings.
-    # @param attrs [*Symbol] a list of the attributes that store symbols
-    klass.define_singleton_method :attr_symbol do |*attrs|
-      # Overwrite each attribute's methods.
-      attrs.each do |attr|
-        # Overwrite the accessor.
-        me.send(:define_method, attr) do
-          val = super()
-          val && val.to_sym
-        end
+  def attr_symbol(*attrs)
+    transform_attributes(*attrs, &:to_sym)
+  end
 
-        # Overwrite the mutator.
-        me.send(:define_method, "#{attr}=") do |val|
-          super(val && val.to_s)
-        end
-      end
-    end
+  def attr_class(*attrs)
+    transform_attributes(*attrs) { |val| Kernel.const_get(val) }
+  end
 
-    # Marks attributes as storing class values, providing setters and getters
-    # for the attributes that will allow the application to use them as classes
-    # but store them internally as strings.
-    # @param attrs [*Symbol] a list of the attributes that store classes
-    klass.define_singleton_method :attr_class do |*attrs|
-      # Overwrite each attribute's methods.
+  # Implementation Note
+  # -------------------
+  # The transformers above all work by creating an anonymous module for each
+  # group of attributes that gets prepended into the class the AttributeHelpers
+  # module is included into. These modules need to be defined at method call
+  # time to avoid leaking the overrided methods into other classes this module
+  # is included in.
+  #
+  # This anonymous module needs to be prepended to work in ActiveRecord classes.
+  # This is because ActiveRecord doesn't have accessors/mutators defined until
+  # an instance is created, which means we need to use the prepend pattern
+  # because attempts to use instance_method instance_method will not find the
+  # method in the class context as it will not exist until it is dynamically
+  # created when an instance is created. Prepend works for us because it inserts
+  # the behavior *below* the class in the inheritance hierarchy, so we can
+  # access the default ActiveRecord accessors/ mutators through the use of
+  # super().
+  #
+  # More information here: http://stackoverflow.com/a/4471202/1103543
+  def transform_attributes(*attrs, &block)
+    transformer = Module.new do
       attrs.each do |attr|
         # Overwrite the accessor.
-        # @raise [NameError] if the string can't be constantized
-        me.send(:define_method, attr) do
+        define_method(attr) do
           val = super()
-          val && Kernel.const_get(val)
+          val && block.call(val)
         end
 
         # Overwrite the mutator.
-        me.send(:define_method, "#{attr}=") do |val|
+        define_method("#{attr}=") do |val|
           super(val && val.to_s)
         end
       end
     end
+
+    prepend transformer
   end
 end

data/lib/attribute_helpers/version.rb

@@ -1,3 +1,3 @@
 module AttributeHelpers
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/active_record_class_spec.rb

@@ -3,16 +3,30 @@ require "spec_helper"
 RSpec.context "in an ActiveRecord class" do
   Temping.create :active_record_test_class do
     with_columns do |t|
+      t.integer :other_symbol_attr
+      t.integer :other_class_attr
       t.string :symbol_attr
       t.string :class_attr
     end
 
-    prepend AttributeHelpers
+    extend AttributeHelpers
 
     attr_symbol :symbol_attr
     attr_class :class_attr
   end
 
+  Temping.create :other_active_record_test_class do
+    with_columns do |t|
+      t.string :other_symbol_attr
+      t.string :other_class_attr
+    end
+
+    extend AttributeHelpers
+
+    attr_symbol :other_symbol_attr
+    attr_class :other_class_attr
+  end
+
   let(:test_obj) { ActiveRecordTestClass.new }
 
   describe ".attr_symbol" do
@@ -48,6 +62,13 @@ RSpec.context "in an ActiveRecord class" do
         expect(test_obj[:symbol_attr]).to be_nil
       end
     end
+
+    context "with attributes that overlap with another class" do
+      it "does not overwrite other attributes" do
+        test_obj.other_symbol_attr = 12345
+        expect(test_obj.other_symbol_attr).to eq 12345
+      end
+    end
   end
 
   describe ".attr_class" do
@@ -94,5 +115,12 @@ RSpec.context "in an ActiveRecord class" do
         expect(test_obj[:class_attr]).to be_nil
       end
     end
+
+    context "with attributes that overlap with another class" do
+      it "does not overwrite other attributes" do
+        test_obj.other_class_attr = 12345
+        expect(test_obj.other_class_attr).to eq 12345
+      end
+    end
   end
 end

data/spec/ruby_class_spec.rb

@@ -2,21 +2,33 @@ require "spec_helper"
 
 RSpec.context "in a pure Ruby class" do
   class RubyTestClass
-    prepend AttributeHelpers
+    extend AttributeHelpers
 
     attr_accessor :symbol_attr
     attr_accessor :class_attr
+    attr_accessor :other_symbol_attr
+    attr_accessor :other_class_attr
 
     attr_symbol :symbol_attr
     attr_class :class_attr
   end
 
+  class OtherRubyTestClass
+    extend AttributeHelpers
+
+    attr_accessor :other_symbol_attr
+    attr_accessor :other_class_attr
+
+    attr_symbol :other_symbol_attr
+    attr_class :other_class_attr
+  end
+
   let(:test_obj) { RubyTestClass.new }
 
   describe ".attr_symbol" do
     describe "getter" do
       it "translates string to symbol" do
-        # Give it an intial value to be read.
+        # Give it an initial value to be read.
         test_obj.instance_variable_set(:@symbol_attr, "example")
 
         expect(test_obj.symbol_attr).to eq :example
@@ -46,6 +58,13 @@ RSpec.context "in a pure Ruby class" do
         expect(test_obj.instance_variable_get(:@symbol_attr)).to be_nil
       end
     end
+
+    context "with attributes that overlap with another class" do
+      it "does not overwrite other attributes" do
+        test_obj.other_symbol_attr = 12345
+        expect(test_obj.other_symbol_attr).to eq 12345
+      end
+    end
   end
 
   describe ".attr_class" do
@@ -92,5 +111,12 @@ RSpec.context "in a pure Ruby class" do
         expect(test_obj.instance_variable_get(:@class_attr)).to be_nil
       end
     end
+
+    context "with attributes that overlap with another class" do
+      it "does not overwrite other attributes" do
+        test_obj.other_class_attr = 12345
+        expect(test_obj.other_class_attr).to eq 12345
+      end
+    end
   end
 end

metadata

@@ -1,113 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: attribute_helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.28'
 - !ruby/object:Gem::Dependency
   name: temping
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Provides auto-serialization of simple Ruby types that databases do not
   support, such as symbols and classes.
 email:
@@ -116,10 +130,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .overcommit.yml
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".overcommit.yml"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -140,17 +154,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Provides auto-serialization of simple Ruby types that databases do not support.