structure 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d836fcee886c983c153695e9d454e42b8ff53ee
-  data.tar.gz: 1b7ebe258505000bb9156f672959ddfaae5608c6
+  metadata.gz: 341847011b94385b6f9db184126c65b671aaea6a
+  data.tar.gz: 479f90296cf23777214e967acbe1f19529edb905
 SHA512:
-  metadata.gz: ec1d7492bc4806441940ec83dca67afef6e445112cf8d025d6326fdc9b65b59300c8dcddd0a8510abb9ae7eff26a870a2151035478e5aa9e101a8994faf4ed4f
-  data.tar.gz: d054f3f46d0759b1fa1044ee56357e77f361bf0fd53b1253d3e683bc4ef579762cb5ca92d48c628183c4363b7198ef8af5b8ee63b536c70c024c0a3c13892871
+  metadata.gz: 39a77be13c27e5b73f3ef9e7e3dcf7c1ac51636b409de4f7dcd761f6bcaee6e8454f7c29742bb1f3707e7907924599a00843b70e9c0ecc77242927a40e7ea799
+  data.tar.gz: 488720d77236008080d9dedeba9cf31c57d17085a3f60a57c2f71c1309e1f7261c5386100fe746bfc038448ba3bc505bc04deec76abee99a486e0489c6581ffa

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2013 Hakan Ensari
+Copyright (c) 2013-14 Hakan Ensari
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,30 +1,46 @@
 # Structure
 
-Turn data (e.g. API responses) into immutable value objects in Ruby.
+Structure is minimal glue that helps you parse data—for instance, API responses—into immutable value objects.
 
 ## Usage
 
-Mix in Structure and define values with `.value`.
+Usage is straightforward. Mix in the module and define the parser methods with `.attribute`, a naming convention I decided to stick to.
 
 ```ruby
 class Location
   include Structure
 
-  attr :res
+  def initialize(data)
+    @data = data
+  end
 
-  def initialize(res)
-    @res = res
+  attribute :latitude do
+    parse(:latitude)
   end
 
-  value :latitude do
-    res.fetch(:lat)
+  attribute :longitude do
+    parse(:longitude)
   end
 
-  value :longitude do
-    res.fetch(:lng)
+  private
+
+  def parse(key)
+    # Heavy-duty parsing action on @data
   end
 end
+```
 
-location = Location.new(lat: 10, lng: 100)
-location.to_h # {:latitude=>10, :longitude=>100}
+Once you have your parser defined, initialise it with some data and take it to a drive.
+
+```ruby
+location = Location.new(data)
+puts location.latitude # => Some latitude
+puts location.to_h # => All attributes as a Ruby Hash
+puts location # => Bonus: This will pretty-inspect the instance
+```
+
+When testing objects the parser collaborates in, you may benefit from a double to stand in for the real parser.
+
+```ruby
+double = Location.to_struct.new(location: 10, latitude: 10)
 ```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structure
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-03 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -38,25 +38,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Value objects in Ruby
-email:
-- hakan.ensari@papercavalier.com
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- lib/structure.rb
-- lib/structure/version.rb
-- structure.gemspec
-- test/structure_test.rb
-homepage: http://github.com/hakanensari/structure
-licenses:
-- MIT
+homepage: 
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -66,7 +57,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -74,9 +65,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Value objects in Ruby
-test_files:
-- test/structure_test.rb
+summary: Parses data into value objects
+test_files: []
+has_rdoc: 

data/.gitignore

@@ -1,6 +0,0 @@
-*.gem
-.bundle
-bin
-coverage
-pkg
-Gemfile.lock

data/Gemfile

@@ -1,2 +0,0 @@
-source 'https://rubygems.org'
-gemspec

data/Rakefile

@@ -1,9 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs.push('lib')
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task :default => [:test]

data/lib/structure.rb

@@ -1,49 +0,0 @@
-module Structure
-  def self.included(base)
-    base.extend(ClassMethods)
-    base.instance_variable_set(:@value_names, [])
-  end
-
-  def values
-    vals = {}
-    self.class.value_names.each { |name| vals[name] = self.send(name) }
-
-    vals
-  end
-
-  def to_h
-    Hash[values.dup.map { |k, v| [k, v.respond_to?(:to_h) ? v.to_h : v] } ]
-  end
-
-  def ==(other)
-    values == other.values
-  end
-  alias :eql? :==
-
-  def inspect
-    str = "#<#{self.class}"
-
-    first = true
-    values.each do |k, v|
-      str << ',' unless first
-      first = false
-      str << " #{k}=#{v.inspect}"
-    end
-
-    str << '>'
-  end
-  alias :to_s :inspect
-
-  module ClassMethods
-    attr :value_names
-
-    def inherited(subclass)
-      subclass.instance_variable_set(:@value_names, value_names.dup)
-    end
-
-    def value(name, &blk)
-      define_method(name, &blk)
-      @value_names << name
-    end
-  end
-end

data/lib/structure/version.rb

@@ -1,3 +0,0 @@
-module Structure
-  VERSION = '0.26.0'
-end

data/structure.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'structure/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'structure'
-  spec.version       = Structure::VERSION
-  spec.authors       = ['Hakan Ensari']
-  spec.email         = ['hakan.ensari@papercavalier.com']
-  spec.description   = 'Value objects in Ruby'
-  spec.summary       = 'Value objects in Ruby'
-  spec.homepage      = 'http://github.com/hakanensari/structure'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split("\n")
-  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_development_dependency 'minitest'
-  spec.add_development_dependency 'rake'
-end

data/test/structure_test.rb

@@ -1,83 +0,0 @@
-require 'minitest/autorun'
-require 'structure'
-
-class Location
-  include Structure
-
-  attr :res
-
-  def initialize(res)
-    @res = res
-  end
-
-  value :latitude do
-    res.fetch(:lat)
-  end
-
-  value :longitude do
-    res.fetch(:lng)
-  end
-end
-
-class StructureTest < MiniTest::Test
-  def setup
-    @location = Location.new(lat: 10, lng: 100)
-  end
-
-  def test_has_value
-    assert_equal 10, @location.latitude
-    assert_equal 100, @location.longitude
-  end
-
-  def test_class_returns_value_names
-    assert_equal [:latitude, :longitude], Location.value_names
-  end
-
-  def test_returns_values
-    assert_equal({ latitude: 10, longitude: 100 }, @location.values)
-    assert_equal @location.to_h, @location.values
-  end
-
-  def test_compares
-    @other = Location.new(lng: 100, lat: 10)
-    assert @location == @other
-    assert @location.eql?(@other)
-  end
-
-  def test_pretty_inspects
-    assert_equal '#<Location latitude=10, longitude=100>', @location.inspect
-    assert_equal @location.to_s, @location.inspect
-  end
-
-  def test_subclasses
-    subclass = Class.new(Location) do
-      value(:name) { 'foo' }
-    end
-    obj = subclass.new(lat: 10, lng: 100)
-
-    assert_equal({ latitude: 10, longitude: 100, name: 'foo' }, obj.values)
-  end
-
-  def test_recursively_casts_to_hash
-    city_class = Class.new do
-      include Structure
-
-      attr :res
-
-      def initialize(res)
-        @res = res
-      end
-
-      value :name do
-        res.fetch(:name)
-      end
-
-      value :location do
-        Location.new(res.fetch(:loc))
-      end
-    end
-
-    city = city_class.new(name: 'London', loc: { lat: 51.5, lng: 0.1 })
-    assert_equal({ name: 'London', location: { latitude: 51.5, longitude: 0.1 }}, city.to_h)
-  end
-end