attrocity 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c66ceb662de478873245283e4016d0039d6ad35
-  data.tar.gz: f1d8aeef00103d3c1c6864fc46f654c6223ad16e
+  metadata.gz: 0ecd334914b12e956f87212e8a6ea99334e85176
+  data.tar.gz: 8f46fc6967abe69da2caf3bac80e7bb9595a45e2
 SHA512:
-  metadata.gz: abd90edfdbb9e98f828e9a50312f1cba09054aabed06dc9eedaac6a59aeafa09a93d3413645de42bc2505b9f53260a69966bee7b4bc271f9f6ccef7cbe4a3f98
-  data.tar.gz: f75a102ad93042b8963dd1b541ba06553a646b9f58d187c67c8b284da06cf0981f76caec73c69670abc07008c90dd53e2a081949d517e089dbc512e30159775e
+  metadata.gz: faf2df44f1fe13921a46eecdab94347bf021c5ed220d8716106e7011b591633c475692a54fa572436efe7f766e6c991e58dda7633c1dfb39af67eb1a92bcc6cc
+  data.tar.gz: e36f0c71909ffea9358b005df5509704f596c59c9f657453c6bee7c02d443e84bb5b8bf55ed34f4874b0ca92f12199e9abe89350545c68c3d38f26012dfc6def

data/.gitignore

@@ -1,14 +1,34 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/test/tmp/
+/test/version_tmp/
 /tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+  - 2.1.8

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    attrocity (0.0.1)
+      hashie (~> 3.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    hashie (3.4.3)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  attrocity!
+  bundler (~> 1.11)
+  rake (~> 10.4)
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 RentPath
+
+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

@@ -1,6 +1,12 @@
-# Attrocity
+Attrocity
+=========
 
 You should totally be using [Virtus](https://github.com/solnic/virtus) instead.
+This gem is a work in progress.
+
+The original code for this gem was written as an employee of
+[RentPath](http://rentpath.com). Since I left RentPath in April 2015, the gem
+has not been touched, so I'm taking over.
 
 ## Installation
 
@@ -20,7 +26,31 @@ Or install it yourself as:
 
 ## Usage
 
-Don't
+Don't. Not yet.
+
+## Objects
+
+### Mappers
+
+A mapper is responsible for extracting values from source data. A mapper object
+responds to `call` and accepts as arguments to call: the instantiated model
+object and the source data hash.
+
+The default, built-in mapper is KeyMapper. When no mapper is explicitly
+declared, KeyMapper is used. It simply fetches from the source data hash, using
+the attribute name as hash key and falling back to nil as default.
+
+### Coercers
+
+Coercers translate mapped data into the correct type. For example, the string
+'1' is coerced to the integer 1 if the built-in integer coercer is used.
+
+The built-in coercers are: string, integer, and boolean.
+
+Custom coercers are the primary way of extracting data when the built-in
+coercers are not sufficient for the use case.
+
+[ ... more stuff on custom coercers here ... ]
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,16 @@
 require "bundler/gem_tasks"
 
+begin
+  require 'rspec/core/rake_task'
+
+  task :default => [:spec]
+
+  desc 'Run specs'
+  RSpec::Core::RakeTask.new(:spec) do |r|
+    r.verbose = false
+  end
+rescue LoadError
+  puts 'RSpec not available.'
+end
+
+

data/TODO.md

@@ -0,0 +1,36 @@
+---
+title: TODO
+---
+
+- [ ] Make a decision about and implement mapped attribute rules
+
+Given the attribute declaration:
+```ruby
+class User
+  include Attrocity.model
+
+  attribute :first_name, coercer: :string, from: :firstname
+end
+```
+
+And the following argument to initialize:
+```ruby
+User.new({ first_name: 'Homer' })
+```
+
+Should the attribute get initialized with user.first_name of Homer? I think it probably should.
+
+It gets a little muddier when there's a default involved, but I like the following prioritization rules:
+
+1. Mapped attribute
+2. Default value
+3. Unmapped attribute
+4. Coercer default return
+
+I think this only applies to the default KeyMapper. It's really about mapping rules. The coercers handle defaults.
+
+--------------------------------------------------------------------------------
+
+- [ ] Compare to Hashie
+
+- [ ] Go through notes.md and edit, update

data/attrocity.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'hashie', '~> 3.4'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency 'rspec', '~> 3.4'
 end

data/lib/attrocity.rb

@@ -1,5 +1,94 @@
-require "attrocity/version"
+module Attrocity
+  CoercionError = Class.new(StandardError)
+end
+
+require 'attrocity/version'
+require 'attrocity/attributes/attribute_template'
+require 'attrocity/attributes/attribute_methods_builder'
+require 'attrocity/attributes/attribute_template_set'
+require 'attrocity/attributes/attributes_hash'
+require 'attrocity/attributes/model_attribute'
+require 'attrocity/attributes/model_attribute_set'
+require 'attrocity/model'
+require 'attrocity/value_extractor'
+require 'attrocity/attributes/attribute'
+require 'attrocity/attributes/attribute_set'
+require 'attrocity/builders/object_extension_builder'
+require 'attrocity/builders/model_builder'
+require 'attrocity/coercer_registry'
+require 'attrocity/coercers/boolean'
+require 'attrocity/coercers/integer'
+require 'attrocity/coercers/string'
+require 'attrocity/mappers/key_mapper'
 
 module Attrocity
-  # Your code goes here...
+
+  def self.model
+    ModelBuilder.new
+  end
+
+  def self.object_extension
+    ObjectExtensionBuilder.new
+  end
+
+  def self.default_mapper
+    KeyMapper
+  end
+
+  module ModuleMethods
+    def attribute(name, coercer:, default: nil, from: name)
+      coercer = CoercerRegistry.instance_for(*coercer_args(coercer))
+      attribute_set << AttributeTemplate.new(name, coercer, mapper(from, default))
+    end
+
+    def coercer_args(args)
+      if args.is_a?(Symbol)
+        [args, {}]
+      elsif args.is_a?(Hash)
+        name = args.delete(:name)
+        [name, args]
+      end
+    end
+
+    def model_attribute(name, model:)
+      ModelAttribute.new(name, model).tap do |model_attr|
+        model_attribute_set << model_attr
+      end
+    end
+
+    def mapper(mapping, default)
+      if mapping.respond_to?(:call)
+        mapping
+      else
+        Attrocity.default_mapper.new(mapping, default)
+      end
+    end
+
+    def attribute_set
+      @attribute_set ||= AttributeTemplateSet.new
+    end
+
+    def model_attribute_set
+      @model_attribute_set ||= ModelAttributeSet.new
+    end
+
+    def model_from_mapped_data(data)
+      attrs = attribute_set.attributes
+      self.new(
+        Hash.new.tap do |h|
+          data.each do |k,v|
+            # TODO: Use more efficient enumerable method
+            key = attrs.collect { |attr| attr.mapper_key_for(k) }.compact.first
+            h[key] = v if key
+          end
+        end
+      ).model
+    end
+  end
+end
+
+Attrocity::CoercerRegistry.register do
+  add :boolean, Attrocity::Coercers::Boolean
+  add :integer, Attrocity::Coercers::Integer
+  add :string, Attrocity::Coercers::String
 end

data/lib/attrocity/attributes/attribute.rb

@@ -0,0 +1,10 @@
+module Attrocity
+  class Attribute
+    attr_reader :name
+    attr_accessor :value
+
+    def initialize(name, value)
+      @name, @value = name, value
+    end
+  end
+end

data/lib/attrocity/attributes/attribute_methods_builder.rb

@@ -0,0 +1,47 @@
+module Attrocity
+  class AttributeMethodsBuilder
+
+    attr_reader :object, :attributes
+
+    def initialize(object, attributes)
+      @object, @attributes = object, attributes
+    end
+
+    def self.for_attribute(obj, attribute)
+      self.new(obj, Array(attribute))
+    end
+
+    def self.for_attribute_set(obj, attribute_set)
+      self.new(obj, attribute_set.attributes)
+    end
+
+    def build
+      attributes.each do |attr|
+        define_methods(attr)
+      end
+    end
+
+    def define_methods(attribute)
+      define_reader(attribute)
+      define_writer(attribute)
+      define_predicate(attribute)
+    end
+
+    def define_reader(attribute)
+      object.define_singleton_method(attribute.name) { attribute.value }
+    end
+
+    def define_writer(attribute)
+      object.define_singleton_method("#{attribute.name}=") do |value|
+        attribute.value = value
+      end
+    end
+
+    def define_predicate(attribute)
+      object.define_singleton_method("#{attribute.name}?") do
+        # TODO: Would true & attribute.value work better here?
+        !!(attribute.value)
+      end
+    end
+  end
+end

data/lib/attrocity/attributes/attribute_set.rb

@@ -0,0 +1,24 @@
+module Attrocity
+  class AttributeSet
+
+    attr_reader :attributes
+
+    def initialize
+      @attributes = Array.new
+    end
+
+    def add(attrs)
+      Array(attrs).each { |attr| attributes << attr }
+    end
+    alias_method :<<, :add
+
+    def to_h
+      Hash.new.tap do |h|
+        attributes.each do |attr|
+          h[attr.name] = attr.value
+        end
+      end
+    end
+
+  end
+end

data/lib/attrocity/attributes/attribute_template.rb

@@ -0,0 +1,28 @@
+module Attrocity
+  class AttributeTemplate
+
+    attr_reader :name, :coercer, :mapper
+
+    def initialize(name, coercer, mapping)
+      @name = name
+      @coercer = coercer
+      @mapper = mapping
+    end
+
+    def to_attribute(data)
+      val = ValueExtractor.new(data, mapper: mapper, coercer: coercer).value
+      Attribute.new(name, val)
+    end
+
+    def mapper_key_for(key)
+      key = key.to_s
+      if name.to_s == key || mapper.key.to_s == key
+        mapper.key
+      else
+        nil
+      end
+    end
+
+  end
+end
+