attribute_cartographer 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*~
+.DS_Store
+.bundle
+.idea
+Gemfile.lock
+doc
+pkg/*
+tags

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2-p136@attribute_cartography --create

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kris Hicks
+
+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/README

@@ -0,0 +1,38 @@
+= Attribute Cartographer
+
+* http://github.com/krishicks/attribute-cartographer
+
+== DESCRIPTION
+
+Attribute Cartographer allows you to map an attributes hash into similarly or differently named methods, using an optional block to map the values as well.
+
+== INSTALL
+
+Add attribute-cartography to your Gemfile
+
+  gem 'attribute-cartographer'
+
+Then run:
+
+  $ bundle
+
+== USAGE
+  class Mapper
+    include AttributeCartographer
+
+    map :a, :b
+    map :c, :d, ->(v) { v.downcase }
+  end
+
+  account = Mapper.new a: 123, c: "Mapper"
+  account.b # => 123
+  account.d # => "Mapper"
+  account.original_attributes # => { a: 123, c: "Mapper" }
+
+== REQUIREMENTS
+
+* Ruby 1.9.x
+
+== LICENSE
+
+MIT

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)

data/attribute_cartographer.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "attribute_cartographer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "attribute_cartographer"
+  s.version     = AttributeCartographer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kris Hicks"]
+  s.email       = ["krishicks@gmail.com"]
+  s.homepage    = "https://github.com/krishicks/attribute-cartographer"
+  s.summary     = %q{Map an attributes hash to methods on Ruby object while transforming the values to suit.}
+  s.description = %q{AttributeCartographer allows you to map an attributes hash into similarly or differently named methods, using an optional block to map the values as well.}
+
+  s.add_development_dependency('rspec', '>= 2.5')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/lib/attribute_cartographer.rb

@@ -0,0 +1,49 @@
+module AttributeCartographer
+  class InvalidBlockArityError < StandardError; end
+  class InvalidArgumentError < StandardError; end
+
+  class << self
+    def included base
+      base.send :extend, AttributeCartographer::ClassMethods
+      base.send :include, AttributeCartographer::InstanceMethods
+    end
+  end
+
+  module ClassMethods
+    def map *args
+      @mapper ||= {}
+      block = (Proc === args.last) ? args.pop : ->(v) { v }
+
+      raise AttributeCartographer::InvalidArgumentError if block.arity > 1
+
+      if Array === args.first
+        raise AttributeCartographer::InvalidArgumentError if args.first.empty?
+        args.first.each { |arg| @mapper.merge! arg => [arg, block] }
+      elsif args.size == 2
+        from, to = args
+        @mapper.merge! from => [to, block]
+      elsif args.size == 1
+        from = args.pop
+        @mapper.merge! from => [from, block]
+      end
+    end
+  end
+
+  module InstanceMethods
+    def initialize attributes
+      @_original_attributes = attributes
+      mapper = self.class.instance_variable_get(:@mapper)
+
+      mapper.each { |from, (meth, block)|
+        value = attributes.has_key?(from) ? block.call(attributes[from]) : nil
+        self.send :define_singleton_method, meth, ->{ value }
+      } if mapper
+
+      super
+    end
+
+    def original_attributes
+      @_original_attributes
+    end
+  end
+end

data/lib/attribute_cartographer/VERSION.rb

@@ -0,0 +1,3 @@
+module AttributeCartographer
+  VERSION = "0.0.1" unless defined?(::AttributeCartographer::VERSION)
+end

data/spec/attribute_cartographer_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe AttributeCartographer do
+  after(:each) do
+    TestClass.instance_variable_set :@mapper, nil
+  end
+
+  let(:klass) {
+    class TestClass
+      include AttributeCartographer
+    end
+  }
+
+  describe "#initialize" do
+    context "with nothing mapped" do
+      it "does not try to map anything when map was not called" do
+        lambda { klass.new(a: :b) }.should_not raise_error
+      end
+    end
+
+    context "with attributes that don't match mapped values" do
+      before { klass.map :a, :b, ->(v) { v + 1 } }
+
+      it "maps attributes to nil when no mappable attribute was passed in" do
+        klass.new(c: :d).b.should be_nil
+      end
+    end
+  end
+
+  describe "#original_attributes" do
+    it "returns any attributes given to initialize" do
+      klass.new(a: :b).original_attributes.should == { a: :b }
+    end
+  end
+
+  describe ".map" do
+    # tests about accepting strings or keys as both args
+    context "with a single argument given" do
+      before { klass.map :a }
+
+      it "creates an instance method matching the key name" do
+        klass.new(:a => :a_value).a.should == :a_value
+      end
+    end
+
+    context "with an empty array" do
+      subject { klass.map [] }
+
+      it "should raise an error" do
+        lambda { klass.map [] }.should raise_error(AttributeCartographer::InvalidArgumentError)
+      end
+    end
+
+    context "with a non-empty array" do
+      before { klass.map [:a, :b] }
+
+      it "creates a method named for each key" do
+        instance = klass.new(a: :a_value, b: :b_value)
+        instance.a.should == :a_value
+        instance.b.should == :b_value
+      end
+
+      it "makes nil methods for mapped keys which had no attributes passed in for them" do
+        instance = klass.new(a: :a_value)
+        instance.b.should == nil
+      end
+    end
+
+    context "with two keys and a 1-arity block given" do
+      before { klass.map :a, :b, ->(v) { v + 1 } }
+
+      it "creates a method named for the second key with the result of passing the associated value to the block" do
+        klass.new(:a => 1).b.should == 2
+      end
+    end
+
+    context "with two keys and a >1-arity block given" do
+      it "raises an error" do
+        lambda { klass.map :a, :b, ->(k,v) { v + 1 } }.should raise_error(AttributeCartographer::InvalidArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "attribute_cartographer"

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: attribute_cartographer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kris Hicks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152785160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *2152785160
+description: AttributeCartographer allows you to map an attributes hash into similarly
+  or differently named methods, using an optional block to map the values as well.
+email:
+- krishicks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- attribute_cartographer.gemspec
+- lib/attribute_cartographer.rb
+- lib/attribute_cartographer/VERSION.rb
+- spec/attribute_cartographer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/krishicks/attribute-cartographer
+licenses: []
+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.7.2
+signing_key: 
+specification_version: 3
+summary: Map an attributes hash to methods on Ruby object while transforming the values
+  to suit.
+test_files:
+- spec/attribute_cartographer_spec.rb
+- spec/spec_helper.rb