random_attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 0fb42eebf2719fd9e4eb30962ce7e4f22917ce2a
+  data.tar.gz: 315f87390f64da8c27f7a751b575d8a823f24f02
+SHA512: 
+  metadata.gz: 5459f78ca52131e811ca1fd89d59d0d6b47d0a1782b5779b690346426ba71e315fb4340da30bc6cc07b31e9193cd80405fc2bb2a5d7311f4a0891c670e01badc
+  data.tar.gz: d0592a236ec2a26f2693803df620c353d6a3dd739516b9719a3ea78ecfef6f0f49ecd93f734e109089c4c2114e55a5cbbc22a37bbd760611b1d00d766f4d73c6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in random_attributes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rufus Post
+
+MIT License
+
+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.md

@@ -0,0 +1,181 @@
+# RandomAttributes
+
+Sometimes people give you rubbish data, when they do rather than wiring
+everything up with hundreds of methods you could use RandomAttributes.
+
+If mangling crappy data is not your issue you are probably better served by
+something like [virtus](https://github.com/solnic/virtus).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'random_attributes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install random_attributes
+
+## Usage
+
+Vanilla:
+
+```ruby
+class Foo
+  include RandomAttributes
+  attribute "fooBar"
+end
+
+foo = Foo.parse { "fooBar" => "hello" }
+foo.foo_bar #=> "hello"
+```
+
+Alias:
+
+```ruby
+class Foo
+  include RandomAttributes
+  attribute "fooBar", alias: :moo_bar
+end
+
+foo = Foo.parse { "fooBar" => "hello" }
+foo.moo_bar #=> "hello"
+```
+
+Type casting:
+
+```ruby
+class Foo
+  include RandomAttributes
+  attribute "fooBar", type: String
+end
+
+foo = Foo.parse { "fooBar" => 34 }
+foo.foo_bar #=> "34"
+```
+
+Many possible values:
+
+```ruby
+class Foo
+  include RandomAttributes
+  attribute ["fooBar", "mooBar"], alias: :foo_bar
+end
+
+foo = Foo.parse { "fooBar" => "hello" }
+foo.foo_bar #=> "hello"
+
+foo = Foo.parse { "mooBar" => "hello" }
+foo.foo_bar #=> "hello"
+```
+
+Trying another node:
+
+```ruby
+class Foo
+  include RandomAttributes
+  attribute "parentNode"
+  attribute "fooBar", try: :parent_node
+end
+
+foo = Foo.parse { "fooBar" => "hello" }
+foo.foo_bar #=> "hello"
+
+foo = Foo.parse { "parentNode" => { "fooBar" => "hello" } }
+foo.foo_bar #=> "hello"
+```
+
+Nested within a node:
+
+```ruby
+class Foo
+  include RandomAttributes
+  attribute "parentNode"
+  attribute "fooBar", within: :parent_node
+end
+
+foo = Foo.parse { "parentNode" => { "fooBar" => "hello" } }
+foo.foo_bar #=> "hello"
+```
+
+Models:
+
+```ruby
+class Bar
+  attr_reader :message
+  def initialize message
+    @message = message
+  end
+end
+
+class Foo
+  include RandomAttributes
+  attribute "fooBar", model: Bar
+end
+
+foo = Foo.parse { "fooBar" => "hello" }
+foo.foo_bar.message #=> "hello"
+```
+
+Collections:
+
+```ruby
+class Bar
+  attr_reader :message
+  def initialize message
+    @message = message
+  end
+end
+
+class Foo
+  include RandomAttributes
+  attribute "fooBar", collection: Bar
+end
+
+foo = Foo.parse { "fooBar" => ["hello", "goodbye"] }
+foo.foo_bar.first.message #=> "hello"
+foo.foo_bar.last.message #=> "goodbye"
+```
+
+Parse data with proc:
+
+```ruby
+class Foo
+  include RandomAttributes
+  attribute "fooBar", parse: ->(value) { "#{value} from a proc!" }
+end
+
+foo = Foo.parse { "fooBar" => "hello" }
+foo.foo_bar #=> "hello from a proc!"
+```
+
+Callbacks:
+
+```ruby
+class Foo
+  include RandomAttributes
+  attribute "fooBar"
+  attribute "multipleFooBar"
+
+  after_parse :multiply_foo_bar
+
+  def multiply_foo_bar
+    set_attribute :multiple_foo_bar, foo_bar * 2
+  end
+end
+
+foo = Foo.parse { "fooBar" => 2 }
+foo.multiple_foo_bar #=> 4
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/random_attributes/version.rb

@@ -0,0 +1,3 @@
+module RandomAttributes
+  VERSION = "0.0.1"
+end

data/lib/random_attributes.rb

@@ -0,0 +1,200 @@
+require "random_attributes/version"
+require "active_support/concern"
+require "active_support/callbacks"
+
+# RandomAttributes
+#
+# Getters, setters and object building for a someone elses data structure.
+#
+# Example:
+#
+#   class Runner
+#     include RandomAttributes
+#     attribute 'runnerName', alias: :name
+#   end
+#
+#   runner = Runner.new "runnerName" => "Phar Lap"
+#   runner.name #=> "Phar Lap"
+#
+module RandomAttributes
+  extend ActiveSupport::Concern
+  include ActiveSupport::Callbacks
+
+  class Register
+    class AliasError < StandardError; end
+
+    attr_reader :originals, :aliased, :type, :parent_node, :try_node
+
+    def initialize(attrs, options = {})
+
+      if attrs.is_a?(Array)
+        raise AliasError, "if you want to alias attributes you need to specify the alias in the options" unless
+          options[:alias].present?
+        @aliased = options[:alias].to_s
+      else
+        @aliased = options[:alias].to_s.presence || attrs.underscore
+        attrs = [attrs]
+      end
+
+      @originals   = attrs
+      @parent_node = options[:within]
+      @try_node    = options[:try]
+
+      @type        = options[:type]
+      @model       = options[:model]
+      @collection  = options[:collection]
+      @cast_proc   = options[:parse] || cast_to_proc
+    end
+
+    def key
+      @originals.join '__'
+    end
+
+    def cast(value)
+      @cast_proc.call value
+    end
+
+    private
+
+    # TODO refactor this.
+    def cast_to_proc
+      if @type
+        ->(value) { value ? Kernel.send(@type.to_s, value) : value }
+      elsif @model
+        ->(value) { value ? @model.parse(value) : value }
+      elsif @collection
+        if @collection.respond_to?(:parse)
+          ->(value) {
+            if value
+              value.map do |member|
+                member.is_a?(@collection) ? member : @collection.parse(member)
+              end
+            else
+              []
+            end
+          }
+        else
+          ->(value) {
+            if value
+              value.map do |member|
+                member.is_a?(@collection) ? member : @collection.new(member)
+              end
+            else
+              []
+            end
+          }
+        end
+      else
+        ->(value) { value }
+      end
+    end
+  end
+
+  included do
+    define_callbacks :parse
+  end
+
+  module ClassMethods
+    def attribute(attrs, options = {})
+      register = Register.new attrs, options
+
+      attribute_register[register.aliased] = register
+
+      define_method register.aliased do
+        get_attribute register
+      end
+
+      define_method :"#{register.aliased}=" do |value|
+        set_attribute register.aliased, value
+      end
+    end
+
+    def attribute_register
+      @_attribute_register ||= {}
+    end
+
+    def parse(attributes)
+      new.parse attributes
+    end
+
+    def before_parse(*args, &block)
+      set_callback(:parse, :before, *args, &block)
+    end
+
+    def after_parse(*args, &block)
+      set_callback(:parse, :after, *args, &block)
+    end
+  end
+
+  def initialize(attrs = nil)
+    parse attrs
+  end
+
+  def cache_key
+    @raw_attributes_hash
+  end
+
+  def parse(attrs = nil)
+    @parsed_attributes = {}
+    attrs && attrs.stringify_keys!
+    run_callbacks :parse do
+      @raw_attributes = attributes.merge(attrs.nil? ? {} : attrs).freeze
+      @raw_attributes_hash = Digest::MD5.hexdigest(attributes.to_s)
+    end
+    self
+  end
+
+  alias :merge_attributes :parse
+
+  def attributes
+    @raw_attributes ||= {}.freeze
+  end
+
+  private
+
+  def parsed_attributes
+    @parsed_attributes ||= {}
+  end
+
+  def get_attribute(register)
+    if parsed_attributes.key?(register.aliased)
+      parsed_attributes[register.aliased]
+    else
+      parsed_attributes[register.aliased] = _get_attribute(register)
+    end
+  end
+
+  def set_attribute(key, value)
+    parsed_attributes[key.to_s] = value
+  end
+
+  def _search_originals(register, node, value = nil)
+     register.originals.each do |key|
+       break if value = node[key]
+     end
+     value
+  end
+
+  def _get_attribute(register)
+
+    value = attributes[register.aliased]
+
+    unless value
+      if register.try_node
+        if try_node = send(register.try_node)
+          value = _search_originals register, try_node
+        else
+          value = _search_originals register, attributes
+        end
+      elsif register.parent_node
+        if parent_node = send(register.parent_node)
+          value = _search_originals register, parent_node
+        end
+      else
+        value = _search_originals register, attributes
+      end
+    end
+
+    register.cast(value)
+  end
+end

data/random_attributes.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'random_attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "random_attributes"
+  spec.version       = RandomAttributes::VERSION
+  spec.authors       = ["Rufus Post"]
+  spec.email         = ["rufuspost@gmail.com"]
+  spec.description   = %q{When someone gives you rubbish data an you want to map it to something else.}
+  spec.summary       = %q{Data hash to object mapper}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "active_support", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "ffaker"
+end

data/spec/random_attributes_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+require 'active_support/core_ext/hash'
+require 'ffaker'
+
+class TestAttributeThing
+  include RandomAttributes
+
+  attribute 'name'
+end
+
+class TestAttributeCasting
+  include RandomAttributes
+
+  attribute 'name'
+  attribute 'venue', type: String
+  attribute 'fooName', alias: :bar_name
+  attribute 'raceIdentifier', alias: :identifier, type: String
+  attribute 'number', type: Integer
+  attribute 'stake', type: Float
+  attribute ['fooMeeting', 'barMeeting'], alias: :meeting
+  attribute 'manyThings', collection: TestAttributeThing
+  attribute 'singleThing', model: TestAttributeThing
+  attribute 'someDetails', alias: :details
+  attribute 'nestedDetail', within: :details
+  attribute ['status', 'raceStatus'], alias: :status, try: :details
+  attribute 'afterParseValue'
+  attribute 'afterOptions', parse: ->(value) { "#{value} after parse!" }
+
+  after_parse :change_value
+
+  def change_value
+    # We have to use this method here because I can't figure out why the
+    # dynamic method is not working.
+    set_attribute :after_parse_value, 'after parse!'
+  end
+end
+
+describe RandomAttributes do
+  let(:string) {
+    Faker::Name.name
+  }
+
+  it "should default to given type" do
+    subject = TestAttributeCasting.parse 'name' => string
+    subject.name.should eq string
+  end
+
+  it "should cast strings and rename attribute" do
+    subject = TestAttributeCasting.parse 'venue' => string
+    subject.venue.should be_a(String)
+  end
+
+  it "should cast floats" do
+    subject = TestAttributeCasting.parse 'stake' => '1.5'
+    subject.stake.should be_a(Float)
+  end
+
+  it "should cast integers" do
+    subject = TestAttributeCasting.parse 'number' => '10'
+    subject.number.should be_a(Integer)
+  end
+
+  it "should rename attributes" do
+    subject = TestAttributeCasting.parse 'raceIdentifier' => string
+    subject.identifier.should eq string
+  end
+
+  it "should create setter method" do
+    subject = TestAttributeCasting.parse 'raceIdentifier' => string
+    subject.identifier = 'Matamata'
+    subject.identifier.should eq 'Matamata'
+  end
+
+  it "should try many attributes" do
+    subject = TestAttributeCasting.parse 'fooMeeting' => nil, 'barMeeting' => string
+    subject.meeting.should eq string
+  end
+
+  it "should try a collection" do
+    subject = TestAttributeCasting.parse 'manyThings' => [{ "name" => string}]
+    subject.many_things.first.name.should eq string
+  end
+
+  it "should just return element if already a collection member" do
+    subject = TestAttributeCasting.parse 'manyThings' => [TestAttributeThing.new(name: string)]
+    subject.many_things.first.name.should eq string
+  end
+
+  it "should memoize instance variables" do
+    subject = TestAttributeCasting.parse 'manyThings' => [{ "name" => string}]
+    subject.many_things.first.object_id.should eq subject.many_things.first.object_id
+  end
+
+  it "should return an array if collection nil" do
+    subject = TestAttributeCasting.parse 'manyThings' => nil
+    subject.many_things.should be_a(Array)
+  end
+
+  it "should try a member" do
+    subject = TestAttributeCasting.parse 'singleThing' => { "name" => string}
+    subject.single_thing.name.should eq string
+  end
+
+  it "should assign something one deep" do
+    subject = TestAttributeCasting.parse 'someDetails' => { 'nestedDetail' => string }
+    subject.nested_detail.should eq string
+  end
+
+  it "should try other places for the data" do
+    subject = TestAttributeCasting.parse 'someDetails' => { 'raceStatus' => string }
+    subject.status.should eq string
+
+    subject = TestAttributeCasting.parse 'raceStatus' => string
+    subject.status.should eq string
+
+    subject = TestAttributeCasting.parse 'status' => string
+    subject.status.should eq string
+  end
+
+  it "should return the aliased value if present" do
+    subject = TestAttributeCasting.parse "bar_name" => string
+    subject.bar_name.should eq string
+  end
+
+  it "should call the after parse method" do
+    subject = TestAttributeCasting.parse "afterParseValue" => string
+    subject.after_parse_value.should eq "after parse!"
+  end
+
+  it "should add a callback from the options hash" do
+    subject = TestAttributeCasting.parse "afterOptions" => string
+    subject.after_options.should eq "#{string} after parse!"
+  end
+
+  it "should clear memoized data when parsed is called" do
+    subject = TestAttributeCasting.new
+
+    subject.name.should be_nil
+
+    subject = TestAttributeCasting.parse 'name' => string
+    subject.name.should eq string
+  end
+
+  it "should have instance method parse methods" do
+    subject = TestAttributeCasting.new
+
+    subject.parse 'name' => 'foo'
+    subject.name.should eq 'foo'
+
+    subject.merge_attributes 'name' => 'bar'
+    subject.name.should eq 'bar'
+  end
+
+  it "should return a reliable cache key" do
+    subject = TestAttributeThing.parse 'name' => 'foo'
+    subject.cache_key.should eq "c9e2bd1b9e2ee9b862a8f035e4ec9d57"
+  end
+
+  it "should return the original raw attributes hash as a cache key" do
+    subject_one = TestAttributeThing.parse 'name' => 'foo'
+    subject_two = TestAttributeThing.parse 'name' => 'foo'
+    subject_one.cache_key.should eq subject_two.cache_key
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'random_attributes'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: random_attributes
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rufus Post
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-12-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id005 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.14"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ffaker
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id005
+  type: :development
+  version_requirements: *id006
+description: When someone gives you rubbish data an you want to map it to something else.
+email: 
+- rufuspost@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/random_attributes.rb
+- lib/random_attributes/version.rb
+- random_attributes.gemspec
+- spec/random_attributes_spec.rb
+- spec/spec_helper.rb
+homepage: ""
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id005
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id005
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Data hash to object mapper
+test_files: 
+- spec/random_attributes_spec.rb
+- spec/spec_helper.rb