attribute_extras 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c7260e54e3e58c841d91e5f50c5d17576704e94
-  data.tar.gz: 8e10f38ea5ed4eb90b9913997d574bb4b1b7d81c
+  metadata.gz: 10a90bb4e6bf56b13a54edf33e931fbfab2bed8a
+  data.tar.gz: 2358a40e44937cd3c03d085be35ff494d2de4dde
 SHA512:
-  metadata.gz: 583c6da1753a9992f590dd16c64336f04e449691acab9ab9cf01fc889a0209305568ed73a80cb53854f6399acfe9405ae3c312ff979dbfffee08296704645c4d
-  data.tar.gz: bf551b72dfdf8f0a2a2daeb2206bf406b001f4d7d069109dba0f6d3c67b02e1614b7669aeac790e15aac808a79d14d4db3a82f3757b9d72cf9c6afba3b8df50d
+  metadata.gz: 1a56ab58683db265c247d3f32ccff17e02dab15bc26888e19396e51d60132760f63387d8a4ea4d3886d55a120c079d5d96cb2d8450886aac253281ba0c63cb5b
+  data.tar.gz: 2f246e1be37f16968fe3e1b905e4aa44191eedacfc5e68f69a2a5f44823826f1227d5c44d27e1180633c2918b3d4fed0d4976df91a5479c3e32807f09333ffbf

data/Rakefile

@@ -5,24 +5,18 @@ rescue LoadError
 end
 
 require 'rdoc/task'
+require 'rake/testtask'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'AttributeExtras'
   rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
-
-
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
-
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
@@ -30,5 +24,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/lib/attribute_extras.rb

@@ -1,7 +1,9 @@
 require 'attribute_extras/extra_builder'
 require 'attribute_extras/hook_builder'
 require 'attribute_extras/modifier'
+require 'logger'
 
+# Used for automatic attribute manipulation
 module AttributeExtras
 
   # the registered extras
@@ -13,6 +15,11 @@ module AttributeExtras
     yield self
   end
 
+  # the logger for attribute extras
+  def self.logger
+    @logger ||= Logger.new($stderr)
+  end
+
   # register the extra and build the functions
   def self.register_extra(verb, function, past:, validator:, options: nil)
     past ||= verb

data/lib/attribute_extras/extra_builder.rb

@@ -1,4 +1,9 @@
 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

data/lib/attribute_extras/hook_builder.rb

@@ -1,4 +1,10 @@
 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
@@ -21,7 +27,7 @@ module AttributeExtras
         <<-RUBY
           def #{@verb}_attributes(*attributes, validator: true, writer: true)
             if self.table_exists? && (non_attributes = attributes.map(&:to_s) - self.column_names).any?
-              raise ArgumentError, "Invalid attributes passed to #{@verb}_attributes: \#{non_attributes.join(', ')}"
+              AttributeExtras.logger.warn("Invalid attributes passed to #{@verb}_attributes: \#{non_attributes.join(', ')}")
             end
 
             include ::AttributeExtras::#{@verb.capitalize}Attributes

data/lib/attribute_extras/modifier.rb

@@ -3,8 +3,13 @@ module AttributeExtras
   # a container for an attribute that has been modified
   class Modifier
 
-    attr_reader :attribute, :options
+    # 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

data/lib/attribute_extras/version.rb

@@ -1,3 +1,6 @@
 module AttributeExtras
-  VERSION = '0.1.2'
+
+  # current version of the gem
+  VERSION = '0.1.3'
+
 end

data/test/base_extensions_test.rb

@@ -2,10 +2,9 @@ require 'test_helper'
 
 class BaseExtensionsTest < ActiveSupport::TestCase
 
-  def test_nullify_attributes_failure
-    assert_raises ArgumentError do
-      klass = address_class(:nullify_attributes, :first_line, :second_line, :third_line)
-      assert_not klass.respond_to?(:nullified_attributes)
+  def test_nullify_attributes_warns
+    assert_output_matches 'Invalid attributes' do
+      address_class(:nullify_attributes, :first_line, :second_line, :third_line)
     end
   end
 
@@ -14,10 +13,9 @@ class BaseExtensionsTest < ActiveSupport::TestCase
     assert_equal klass.nullified_attributes.map(&:attribute), [:first_line, :second_line]
   end
 
-  def test_strip_attributes_failure
-    assert_raises ArgumentError do
-      klass = address_class(:strip_attributes, :first_line, :second_line, :third_line)
-      assert_not klass.respond_to?(:stripped_attributes)
+  def test_strip_attributes_warns
+    assert_output_matches 'Invalid attributes' do
+      address_class(:strip_attributes, :first_line, :second_line, :third_line)
     end
   end
 
@@ -26,13 +24,6 @@ class BaseExtensionsTest < ActiveSupport::TestCase
     assert_equal klass.stripped_attributes.map(&:attribute), [:first_line, :second_line]
   end
 
-  def test_truncate_attributes_failure
-    assert_raises ArgumentError do
-      klass = address_class(:truncate_attributes, :first_line, :second_line, :third_line)
-      assert_not klass.respond_to?(:truncated_attributes)
-    end
-  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]
@@ -48,4 +39,14 @@ class BaseExtensionsTest < ActiveSupport::TestCase
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribute_extras
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -92,3 +106,4 @@ test_files:
 - test/test_classes.rb
 - test/test_helper.rb
 - test/truncate_attributes_test.rb
+has_rdoc: