natural_born_slugger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c53161bfaee3307f0789e14966a1cef3def933f3
-  data.tar.gz: b0d8d1d8e94fae0798e5ad1b6411d21ff50a18c0
+  metadata.gz: cf8a2e95a9e37528207d180abcfefda53ee8c4a2
+  data.tar.gz: 3b12053c7a01c7805a19750ed9eaa73082552fbb
 SHA512:
-  metadata.gz: 4847802082fabbcb6f537d607f8cabf918fda7a258966c4ac0b43e9a7fe7a89794f1880a2b1a9918c800a80c1d9ab23c3fb15d2f0fca151b32eb6a5e1d443390
-  data.tar.gz: b93c87ae94fec058f6dac6e6027cc5dde19ab2880a7d292dfd89f5eeca71cada422cc8fbc326a3acfb3755789c5469716190bc7ac0167d943ad2d063ead921fc
+  metadata.gz: 4e7781ec967dc3e89fca75c3a232e203cecd8098841ceecea00878a300353089fbef75c3a4889a06dd2b0beaa8eda0a9a1b5650d5c72bebf3ba23202cdacef76
+  data.tar.gz: 0fd95992883ed518d066ae9fbdf545466820556bd870c361e41c6dc25cc110775424f9b7cc7313b0e1535f15dd42db912be4ba9d555ea3d8333af2649be6c5aa

data/.rspec

@@ -0,0 +1,11 @@
+# Autoload spec helper
+--require spec_helper
+
+# Show more colorful RSpec results
+--color
+
+# Verbose display
+--format documentation
+
+# Use full backtraces
+-b

data/README.md

@@ -116,22 +116,7 @@ The options hash is where you define the attribute's dependencies. It also uses
 
     bambino = Person.new('Babe', nil, 'Ruth')
     bambino.slug #=> "Babe-Ruth"
-```
-
-##### `:compact`
-  - Removes nil dependencies before joining.
-  - Default: true
-  - Example: Notice the extra dash in the example below:
 
-```
-    Person = Struct.new(:first_name, :middle_name, :last_name) do
-      include NaturalBornSlugger
-      has_slug first_name: nil, middle_name: nil, last_name: nil, compact: false, join_with: '-'
-    end
-
-    bambino = Person.new('Babe', nil, 'Ruth')
-    bambino.slug #=> "Babe--Ruth"
-```
 
 ##### `:require_all`
   - Checks to make sure all attributes exist before composing attribute.
@@ -152,7 +137,7 @@ The options hash is where you define the attribute's dependencies. It also uses
     bambino.slug #=> "George-Herman-Ruth"
 ```
 
-##### `:track`
+##### `:callback`
   - Provides a callback function `#{attribute_name}_change` to allow you to persist old slugs as you please.
   - Default: false
   - Example:
@@ -160,13 +145,12 @@ The options hash is where you define the attribute's dependencies. It also uses
 ```
     Person = Struct.new(:first_name, :middle_name, :last_name) do
       include NaturalBornSlugger
-      has_slug first_name: nil, middle_name: nil, last_name: nil, track: true
-
       attr_accessor :formerly_known_as
-      def slug_change(old_slug, new_slug)
-        @formerly_known_as ||= []
-        @formerly_known_as << old_slug
+      has_slug first_name: nil, middle_name: nil, last_name: nil, callback: ->(old_name, new_name) do
+        self.formerly_known_as ||= []
+        self.formerly_known_as << old_name
       end
+
     end
 
     bambino = Person.new('George', 'Herman', 'Ruth')
@@ -179,4 +163,4 @@ The options hash is where you define the attribute's dependencies. It also uses
 
 ##### _Note:_
 
-If you happen to have methods or attributes called `join_with`, `compact`, `require_all`, or `track`, you can still build composite attributes out of them. Just use a string instead of a symbol when declaring your attribute's dependencies. `NaturalBornSlugger` only looks for symbols when reading your dependencies for these settings.
+If you happen to have methods or attributes called `join_with`, `require_all`, or `callback`, you can still build composite attributes out of them. Just use a string instead of a symbol when declaring your attribute's dependencies. `NaturalBornSlugger` only looks for symbols when reading your dependencies for these settings.

data/lib/natural_born_slugger/attribute_composer.rb

@@ -0,0 +1,116 @@
+module NaturalBornSlugger
+  class AttributeComposer
+
+    def initialize(name, options)
+      @name = name.to_s
+      @dependencies, options = self.class.extract_dependencies_from_options(options)
+      options.each do |option, value|
+        self.instance_variable_set("@#{option}", value)
+      end
+      raise ConfigurationError.new(self.name, name, "no dependent attributes were specified") if @dependencies.empty?
+    end
+
+    def self.default_options
+      {
+        require_all: false,
+        join_with: '',
+        callback: false
+      }
+    end
+
+    def self.extract_dependencies_from_options(dependencies={})
+      options = default_options.dup
+      options.keys.each do |option|
+        if dependencies.has_key? option
+          options[option] = dependencies.delete(option)
+        end
+      end
+      [dependencies, options]
+    end
+
+    def self.resolve_dependency(object, dependency)
+      dependency_chain = dependency.to_s.split('.')
+      dependency_chain.each do |method|
+        object = object.try :send, method
+        break unless object
+      end
+      object
+    end
+
+
+    def compose_attribute(resolved_dependencies)
+      resolved_dependencies.map do |resolved_dependency, strategy|
+        case strategy
+        when Symbol # Symbols represent string methods to call on the resolved dependency
+          resolved_dependency.to_s.send(strategy)
+        when String # Strings represent formats to fit the resolved dependency into
+          strategy % resolved_dependency
+        when Regexp # Regexps represent patterns to pull out of the resolved dependency and join
+          resolved_dependency.scan(strategy).join(@join_with)
+        when Proc   # Procs should take one parameter and return a string or nil
+          strategy.call(resolved_dependency)
+        else        # If no strategy provided, use resolved dependency as is
+          resolved_dependency.to_s
+        end
+      # Remove nil components if `compact_dependencies` is true
+      end.reject{|string| not string or string.empty? }.join(@join_with)
+    end
+
+    def evaluate(object)
+      resolved_dependencies = @dependencies.map do |dependency, strategy|
+        [self.class.resolve_dependency(object, dependency), strategy]
+      end
+      # Check existence of all attribute dependencies if `require_all` is true
+      if @require_all ? resolved_dependencies.map(&:first).all? : true
+        compose_attribute(resolved_dependencies)
+      end
+    end
+
+    def callback(object, old_value, new_value)
+      if @callback
+        unless old_value == new_value
+          object.instance_exec old_value, new_value, &@callback
+        end
+      end
+    end
+
+    ##
+    # Adds composite attribute methods to the class:
+    #  a getter, and updater method.
+    # Also adds a setter that either calls the updater
+    #  or throws an error, depending on configuration
+    def add_to(klass)
+
+      class << klass
+        attr_accessor :composite_attributes
+      end
+      klass.composite_attributes ||= {}
+      klass.composite_attributes[@name] = self
+
+      # Define instance attribute getter
+      klass.send :define_method, @name do
+        name = __method__
+        self.send "update_#{name}"
+      end
+
+      # Define instance attribute setter: ignores assignment and just triggers an update
+      klass.send :define_method, "#{@name}=" do |value|
+        name = __method__.to_s.gsub '=', ''
+        self.send "update_#{name}"
+      end
+
+      # Update instance attribute
+      klass.send :define_method, "update_#{@name}" do
+        name = __method__.to_s.gsub 'update_', ''
+        composer = self.class.composite_attributes[name]
+        old_value = self.instance_variable_get("@#{name}")
+        new_value = composer.evaluate(self)
+        self.instance_variable_set("@#{name}", new_value)
+        composer.callback(self, old_value, new_value)
+        new_value
+      end
+
+    end
+
+  end
+end

data/lib/natural_born_slugger/class_methods.rb

@@ -1,3 +1,5 @@
+require "natural_born_slugger/attribute_composer"
+
 module NaturalBornSlugger
   module ClassMethods
 
@@ -7,8 +9,7 @@ module NaturalBornSlugger
     def has_slug(name, options={})
       # Use default name if not provided
       name, options = 'slug', name if name.is_a?(Hash)
-      dependencies, options = extract_composite_dependencies(name, options)
-      build_composite_attribute(name.to_s, dependencies, options)
+      NaturalBornSlugger::AttributeComposer.new(name, options).add_to(self)
     end
 
     ##
@@ -17,84 +18,14 @@ module NaturalBornSlugger
     def has_natural_key(name, options={})
       # Use default name if not provided
       name, options = 'natural_key', name if name.is_a?(Hash)
-      dependencies, options = extract_composite_dependencies(name, options)
-      build_composite_attribute(name.to_s, dependencies, options)
+      NaturalBornSlugger::AttributeComposer.new(name, options).add_to(self)
     end
 
     ##
     # Adds a generic composite attribute to the class. Name is required.
     #
     def has_composite_attribute(name, options={})
-      dependencies, options = extract_composite_dependencies(name, options)
-      build_composite_attribute(name.to_s, dependencies, options)
-    end
-
-  private
-
-    ##
-    # Pulls method behavior options out of general options. The remaining options
-    #  are assumed to be the dependent attributes that compose this one.
-    #
-    def extract_composite_dependencies(name, options={})
-      dependencies, options = options, {}
-
-      options[:compact_dependencies] =  dependencies.delete(:compact)       || true
-      options[:require_dependencies] =  dependencies.delete(:require_all)   || false
-      options[:track_changes] =         dependencies.delete(:track)         || false
-      options[:joiner] =                dependencies.delete(:join_with)     || ''
-
-      raise ConfigurationError.new(self.name, name, "no dependent attributes were specified") if dependencies.empty?
-
-      [dependencies, options]
-    end
-
-    ##
-    # Adds a composite attribute to the class,
-    #  with a getter and updater method.
-    # Also adds a setter that either calls the updater
-    #  or throws an error, depending on configuration.
-    #
-    def build_composite_attribute(name, dependencies, options)
-
-      # Define instance attribute getter
-      define_method name do
-        self.send "update_#{name}"
-      end
-
-      # Define instance attribute setter: ignores assignment and just triggers an update
-      define_method "#{name}=" do |value|
-        if NaturalBornSlugger.configuration.ignore_attribute_setters
-          # TODO: Log discarded value warning
-          self.send "update_#{name}"
-        else
-          raise IllegalOperationError.new(self.class.name, "#{name}=", 'you cannot set composite attributes directly')
-        end
-      end
-
-      # Update instance attribute
-      define_method "update_#{name}" do
-        # Check existence of all attribute dependencies if `require_dependencies` is true
-        resolved_dependencies = dependencies.map do |dependency, strategy|
-          [resolve_dependency(dependency), strategy]
-        end
-        if options[:require_dependencies] ? resolved_dependencies.map(&:first).all? : true
-          new_value = self.compose_attribute(resolved_dependencies, options)
-          if options[:track_changes]
-            old_value = self.instance_variable_get("@#{name}")
-            unless old_value == new_value
-              self.send("#{name}_change".to_sym, old_value, new_value)
-            end
-          end
-          self.instance_variable_set("@#{name}", new_value)
-        end
-      end
-
-      if [:track_changes]
-        define_method "#{name}_change" do |old_value, new_value|
-
-        end
-      end
-
+      NaturalBornSlugger::AttributeComposer.new(name, options).add_to(self)
     end
 
   end

data/lib/natural_born_slugger/configuration.rb

@@ -1,11 +1,14 @@
+require 'logger'
+
 module NaturalBornSlugger
   class Configuration
 
-    attr_accessor :ignore_attribute_setters, :hashified_length
+    attr_accessor :ignore_attribute_setters, :hashified_length, :logger
 
     def initialize
       @ignore_attribute_setters = true
       @hashified_length = 7
+      @logger = Logger.new(STDERR)
     end
 
   end

data/lib/natural_born_slugger/extensions/string.rb

@@ -1,4 +1,5 @@
-require 'active_support/inflector/transliterate'
+require 'active_support/inflector'
+
 class String
 
   alias_method :dashify, :parameterize

data/lib/natural_born_slugger/version.rb

@@ -1,3 +1,3 @@
 module NaturalBornSlugger
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/natural_born_slugger.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/object/try'
 
 require "natural_born_slugger/exceptions"
 require "natural_born_slugger/configuration"
@@ -14,8 +15,7 @@ module NaturalBornSlugger
 
     yield(configuration) if block_given?
 
-    require "natural_born_slugger/class_methods"
-    require "natural_born_slugger/instance_methods"
+    require_internals!
 
     configuration
   end
@@ -27,6 +27,12 @@ module NaturalBornSlugger
   def self.included(base)
     base.extend ClassMethods
   end
+
+private
+
+  def self.require_internals!
+    require "natural_born_slugger/class_methods"
+  end
 end
 
 require "natural_born_slugger/extensions/string"

data/natural_born_slugger.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard",       "~> 0.8"
   spec.add_development_dependency "redcarpet",  "~> 2.2"
   spec.add_development_dependency "rspec",      "~> 2.13"
+  spec.add_development_dependency "pry"
 
   spec.add_dependency 'activesupport',          '~> 3.1'
 end

data/spec/natural_born_slugger/attribute_builder_spec.rb

@@ -0,0 +1,70 @@
+describe NaturalBornSlugger::AttributeComposer do
+
+  context 'class methods' do
+    subject(:composer){ NaturalBornSlugger::AttributeComposer }
+
+    describe ".default_options" do
+      it "should not require that all dependent attributes be present to form composite" do
+        composer.composite_options[:require_all].should be_false
+      end
+      it "should not join depencencies with a special character" do
+        composer.composite_options[:join_with].should be_empty
+      end
+      it "should not use a callback" do
+        composer.composite_options[:callback].should be_false
+      end
+    end
+
+    describe ".extract_dependencies_from_options" do
+      let(:empty_opts) { {} }
+      let(:simple_opts) { {name: 'foobar', title: 'asdf'} }
+      let(:config_opts) { {require_all: true, join_with: '^'} }
+      let(:mixed_opts) { {name: 'foobar', title: 'asdf', require_all: true, join_with: '^'} }
+      it "should always return 3 options" do
+        [empty_opts, simple_opts, config_opts, mixed_opts].each do |options|
+          _, opts = composer.extract_dependencies_from_options(options)
+          opts.length.should eql composer.composite_options.length
+        end
+      end
+    end
+
+    describe ".resolve_dependency" do
+      let(:example_object) { Example.new }
+      it "should retrieve attributes listed as a dependency" do
+        composer.resolve_dependency(example_object, 'attribute').should == 'attribute'
+      end
+      it "should use the results of methods listed as a dependency" do
+        composer.resolve_dependency(example_object, 'meth').should == 'method'
+      end
+      it "should accept methods that return objects as a dependency" do
+        composer.resolve_dependency(example_object, 'child').should be_an ExampleChild
+      end
+      context "through related objects via dot syntax" do
+        it "should resolve a related object's attributes" do
+          composer.resolve_dependency(example_object, 'child.attribute').should == 'child attribute'
+        end
+        it "should resolve a related object's methods" do
+          composer.resolve_dependency(example_object, 'child.meth').should == 'child method'
+        end
+        it "should resolve a related object's own related objects" do
+          composer.resolve_dependency(example_object, 'child.child').should be_an ExampleGrandChild
+        end
+      end
+    end
+
+  end
+
+
+  context 'instance methods' do
+
+    describe '#compose_attribute' do
+
+    end
+
+    describe '#evaluate' do
+
+    end
+
+  end
+
+end

data/spec/natural_born_slugger/configuration_spec.rb

@@ -0,0 +1,18 @@
+describe NaturalBornSlugger::Configuration do
+  subject(:config) { NaturalBornSlugger.configuration }
+
+  describe "the default configuration" do
+
+    it "should ignore attribute setters" do
+      config.ignore_attribute_setters.should be_true
+    end
+    it "should truncate hashed values at 7" do
+      config.hashified_length.should eql(7)
+    end
+    it "should have a basic logger" do
+      config.logger.should be_a(Logger)
+    end
+
+  end
+
+end

data/spec/natural_born_slugger/extensions/string_spec.rb

@@ -0,0 +1,5 @@
+describe String do
+  subject { 'foobar' }
+  it { should respond_to :dashify }
+  it { should respond_to :hashify }
+end

data/spec/natural_born_slugger_spec.rb

@@ -0,0 +1,17 @@
+describe NaturalBornSlugger do
+  subject(:library) { NaturalBornSlugger }
+
+  context "in order to be configurable" do
+    it { should respond_to :configuration }
+    it { should respond_to :configure }
+
+    it "should require library internals after configuration" do
+      library.should_receive(:require_internals!)
+      library.configure
+    end
+  end
+
+  context "in order to write to logs" do
+    it { should respond_to :logger }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'pry'
+require 'rspec'
+require 'natural_born_slugger'
+
+NaturalBornSlugger.configure
+require 'support/example'
+
+RSpec.configure

data/spec/support/example.rb

@@ -0,0 +1,36 @@
+class Example
+  include NaturalBornSlugger
+  attr_accessor :attribute
+  def initialize
+    @attribute = 'attribute'
+  end
+  def meth
+    'method'
+  end
+  def child
+    ExampleChild.new
+  end
+end
+
+class ExampleChild
+  attr_accessor :attribute
+  def initialize
+    @attribute = 'child attribute'
+  end
+  def meth
+    'child method'
+  end
+  def child
+    ExampleGrandChild.new
+  end
+end
+
+class ExampleGrandChild
+  attr_accessor :attribute
+  def initialize
+    @attribute = 'grandchild attribute'
+  end
+  def meth
+    'grandchild method'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natural_born_slugger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Christopher Keele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -103,19 +117,26 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .yardopts
+- .rspec
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - lib/natural_born_slugger.rb
+- lib/natural_born_slugger/attribute_composer.rb
 - lib/natural_born_slugger/class_methods.rb
 - lib/natural_born_slugger/configuration.rb
 - lib/natural_born_slugger/exceptions.rb
 - lib/natural_born_slugger/extensions/string.rb
-- lib/natural_born_slugger/instance_methods.rb
 - lib/natural_born_slugger/version.rb
 - natural_born_slugger.gemspec
+- spec/natural_born_slugger/attribute_builder_spec.rb
+- spec/natural_born_slugger/class_methods_spec.rb
+- spec/natural_born_slugger/configuration_spec.rb
+- spec/natural_born_slugger/extensions/string_spec.rb
+- spec/natural_born_slugger_spec.rb
+- spec/spec_helper.rb
+- spec/support/example.rb
 homepage: ''
 licenses:
 - MIT
@@ -141,5 +162,12 @@ signing_key:
 specification_version: 4
 summary: Easily define automatically-updated composed attributes. Includes ORM helpers
   and a Rack-based URL redirector.
-test_files: []
+test_files:
+- spec/natural_born_slugger/attribute_builder_spec.rb
+- spec/natural_born_slugger/class_methods_spec.rb
+- spec/natural_born_slugger/configuration_spec.rb
+- spec/natural_born_slugger/extensions/string_spec.rb
+- spec/natural_born_slugger_spec.rb
+- spec/spec_helper.rb
+- spec/support/example.rb
 has_rdoc: 

data/.yardopts

@@ -1 +0,0 @@
-- LICENSE.md

data/lib/natural_born_slugger/instance_methods.rb

@@ -1,33 +0,0 @@
-module NaturalBornSlugger
-
-  def resolve_dependency(dependency)
-    object = self
-    dependency_chain = dependency.to_s.split('.')
-    dependency_chain.each do |method|
-      object = object.try :send, method
-      break unless object
-    end
-    object
-  end
-
-  def compose_attribute(resolved_dependencies, options)
-    resolved_dependencies.map do |resolved_dependency, strategy|
-      case strategy
-      when Symbol # Symbols represent string methods to call on the resolved dependency
-        resolved_dependency.to_s.send(strategy)
-      when String # Strings represent formats to fit the resolved dependency into
-        strategy % resolved_dependency
-      when Regexp # Regexps represent patterns to pull out of the resolved dependency and join
-        resolved_dependency.scan(strategy).join(options[:joiner])
-      when Proc   # Procs should take one parameter and return a string or nil
-        strategy.call(resolved_dependency)
-      else        # If no strategy provided, use resolved dependency as is
-        resolved_dependency.to_s
-      end
-    # Remove nil components if `compact_dependencies` is true
-    end.tap do |components|
-      components.compact! if options[:compact_dependencies]
-    end.join(options[:joiner])
-  end
-
-end