simple_objects 0.0.1 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 939d6dec189dfd4d07db852f4070b3ac9a4eb025
-  data.tar.gz: 6918a585dcafe58adfdc5854a1ce6fc407219f23
+  metadata.gz: c25d89aba39253b82e542b1100d04dea62df0c6d
+  data.tar.gz: 6dae5572e49c5eee2519de5b3e8a7d37bec27fda
 SHA512:
-  metadata.gz: 24078705f7012cb3ceb679862528b78312136aadba25a95fe16f7b48706510b9f9f2054468e1eee450ad59e7fd6f2c37e0580c11aab71c817dbd780741181e5c
-  data.tar.gz: c9c94f5390f310456c24ca9f26ce0fc150f6f56b859098d39cc357b1b629b2426a702c7908db0b9ec65ed76bb2d2223c8adb3ba24739f3f40844eab5f212e193
+  metadata.gz: 473a79775e34bfd9cd8d2fa15de5e8820b1560d711ee503f2a05bc790d5c29042d7c994c68e8120f88e509f6846e8acf3fa2eab643b2cd3d74f5aaba21ac11bf
+  data.tar.gz: ca526a84eed486ca988d9fc1e5470d46fccf110234d75f5959822e69657b253657cbdb3e6ebf3e61d58a39317a56817d53d59b8ec0defd67deb47f7f69510e1f

data/.gitignore

@@ -1,14 +1,63 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
+# Created by https://www.gitignore.io
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/test/tmp/
+/test/version_tmp/
 /tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/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
+
+### OSX ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Vim ###
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - ruby-head
+script: bundle exec rspec
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.md

@@ -1,31 +1,45 @@
-# SimpleObject
+# SimpleObjects
 
-TODO: Write a gem description
+Simple objects for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/simple_objects.png)](https://rubygems.org/gems/simple_objects) [![Build Status](https://travis-ci.org/doomspork/simple_objects.svg?branch=master)](https://travis-ci.org/doomspork/simple_objects) [![Code Climate](https://codeclimate.com/github/doomspork/simple_objects/badges/gpa.svg)](https://codeclimate.com/github/doomspork/simple_objects) [![Coverage Status](https://coveralls.io/repos/doomspork/simple_objects/badge.png?branch=master)](https://coveralls.io/r/doomspork/simple_objects?branch=master) [![Dependency Status](https://gemnasium.com/doomspork/simple_objects.svg)](https://gemnasium.com/doomspork/simple_objects)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'simple_object'
-```
+	gem 'simple_objects'
 
-And then execute:
+And require it:
 
-    $ bundle
+	require 'simple_objects'
 
-Or install it yourself as:
+## Usage
 
-    $ gem install simple_object
+```ruby
+class SuperHero
+	include SimpleObjects::Base
+	
+	attribute :name, required: true, type: String
+	attribute :power, required: true, type: String
+	attribute :age, type: Numeric
+end
 
-## Usage
+SuperHero.new(name: 'Superman', power: 'Super stuff', age: 34)
 
-TODO: Write usage instructions here
+SuperHero.new(name: 'Spiderman', age: 20) #=> raises RequiredMissingError
+
+SuperHero.new(name: 'Spiderman', power: {}) #=> raises MismatchedTypeError
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/doomspork/simple_object/fork )
-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 a new Pull Request
+Feedback and fixes are always welcome.  Please make use of [Issues](https://github.com/doomspork/simple_objects/issues) and [Pull Requests](https://github.com/doomspork/simple_objects/pulls), all code should have test coverage.
+
+## Author/Contact
+
+SimpleObjects is written and maintained by [@doomspork](github.com/doomspork).
+
+## License
+
+SimpleObjects is made available under the [MIT](http://opensource.org/licenses/MIT) License.

data/lib/simple_objects/attribute.rb

@@ -0,0 +1,19 @@
+module SimpleObjects
+  class Attribute
+    attr_accessor :default, :name, :required, :type
+
+    def initialize(name, opts = {})
+      @name = name
+      @required = false
+      apply_opts(opts)
+    end
+
+    private
+
+    def apply_opts(opts)
+      opts.each do |opt, value|
+        send("#{opt}=", value) if respond_to?(opt)
+      end
+    end
+  end
+end

data/lib/simple_objects/attributes.rb

@@ -0,0 +1,59 @@
+require_relative 'attribute'
+require_relative 'errors/mismatched_type_error'
+require_relative 'errors/required_missing_error'
+
+module SimpleObjects
+  module Attributes
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_reader :attributes
+
+      def attribute(attribute, opts = {})
+        @attributes ||= {}
+        attr = Attribute.new(attribute, opts)
+        @attributes[attribute] = attr
+        send(:attr_reader, attribute)
+      end
+
+      def attributes
+        @attributes || {}
+      end
+    end
+
+    protected
+
+    def mass_assign(inputs)
+      attributes.each do |(name, attr)|
+        value = inputs[name]
+        if value
+          mismatch(attr, value) if (type = attr.type) && !(value.is_a? type)
+          set_value(name, value)
+          next
+        end
+
+        missing(name) if attr.required
+        set_value(name, attr.default) if attr.default
+      end
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    def set_value(name, value)
+      instance_variable_set("@#{name}", value)
+    end
+
+    def missing(name)
+      raise RequiredMissingError.new("Missing required value for #{name}")
+    end
+
+    def mismatch(attribute, value)
+      raise MismatchedTypeError.new("Expected #{attribute.name} to be #{attribute.type} but was #{value.class}")
+    end
+  end
+end

data/lib/simple_objects/base.rb

@@ -1,59 +1,17 @@
-require_relative 'defaults'
+require_relative 'attributes'
+require_relative 'serialization'
 
 module SimpleObjects
   module Base
+    include Attributes
+    include Serialization
 
     def self.included(base)
       base.extend(ClassMethods)
     end
 
-    module ClassMethods
-      def attr_accessor(*attrs)
-        @attributes ||= []
-        @attributes.concat(attrs)
-        super(*attrs)
-      end
-
-      def attributes
-        @attributes || []
-      end
-    end
-
     def initialize(attributes = {})
-      values = defaults.merge(attributes)
-      values.each do |attr, value|
-        mthd = "#{attr}="
-        send(mthd, value) if self.respond_to?(mthd)
-      end
-    end
-
-    def to_h
-      attributes.each_with_object({}) do |k, hsh|
-        val = send(k)
-        if val.nil?
-          val = nil
-        elsif val.respond_to?(:to_h)
-          val = val.to_h
-        elsif val.respond_to?(:map)
-          val = val.map { |v| v.respond_to?(:to_h) ? v.to_h : v }
-        end
-        hsh[k] = val
-      end
-    end
-
-    def as_json(opts = {})
-      to_h.as_json(opts)
-    end
-
-    def cache_key
-      individual_key = [@id || 'new', @updated_at].reject(&:nil?).join('-')
-      "#{self.class.to_s.underscore}/#{individual_key}"
-    end
-
-    protected
-
-    def attributes
-      self.class.attributes
+      mass_assign(attributes)
     end
   end
 end

data/lib/simple_objects/errors/mismatched_type_error.rb

@@ -0,0 +1,2 @@
+class MismatchedTypeError < RuntimeError
+end

data/lib/simple_objects/errors/required_missing_error.rb

@@ -0,0 +1,2 @@
+class RequiredMissingError < RuntimeError
+end

data/lib/simple_objects/serialization.rb

@@ -0,0 +1,40 @@
+module SimpleObjects
+  module Serialization
+    def to_h(opts = {})
+      apply_options(opts)
+    end
+
+    alias_method :to_hash, :to_h
+
+    private
+
+    def apply_options(opts)
+      hsh = hashed_values
+      return sub_hash(hsh, opts[:only]) if opts[:only]
+      opts[:except].each { |attr| hsh.delete(attr) } if opts[:except]
+      (opts[:methods] || {}).each_with_object(hsh) do |method, memo|
+        memo[method] = send(method)
+      end
+    end
+
+    def sub_hash(hash, keys)
+      hash.select { |(key, _)| keys.include?(key) }
+    end
+
+    def hashed_values
+      attributes.each_with_object({}) do |k, hsh|
+        val = send(k)
+        # `nil.to_h` => {} which we do not want
+        if val.nil?
+          val = nil
+        elsif val.respond_to?(:map)
+          val = val.map { |v| v.respond_to?(:to_h) ? v.to_h : v }
+        elsif val.respond_to?(:to_h)
+          val = val.to_h
+        end
+        hsh[k] = val
+      end
+    end
+
+  end
+end

data/lib/simple_objects/version.rb

@@ -1,3 +1,3 @@
 module SimpleObjects
-  VERSION = '0.0.1'
+  VERSION = '1.0'
 end

data/lib/simple_objects.rb

@@ -2,6 +2,4 @@ require 'simple_objects/version'
 require 'simple_objects/base'
 
 module SimpleObjects
-  include Base
-  include Defaults
 end

data/spec/lib/simple_objects/attribute_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module SimpleObjects
+  describe Attribute do
+    subject { Attribute.new('test') }
+
+    it { is_expected.to respond_to :default }
+    it { is_expected.to respond_to :name }
+    it { is_expected.to respond_to :required }
+    it { is_expected.to respond_to :type }
+
+    context 'with options' do
+      subject { Attribute.new('test', default: 'foo', type: String, required: true) }
+
+      its(:name) { is_expected.to eq 'test' }
+      its(:default) { is_expected.to eq 'foo' }
+      its(:required) { is_expected.to be_truthy }
+      its(:type) { is_expected.to eq String }
+    end
+  end
+end

data/spec/lib/simple_objects/attributes_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+module SimpleObjects
+  describe Attributes do
+
+    describe '.attribute' do
+      class BasicExample
+        include Attributes
+
+        attribute :foo
+      end
+
+      subject { BasicExample.new }
+
+      it { is_expected.to respond_to :foo }
+    end
+
+    describe '#mass_assign' do
+      context 'with option' do
+        class OptionsExample
+          include Attributes
+
+          attribute :one
+          attribute :two, required: true
+          attribute :three, default: 'three'
+          attribute :four, type: String
+        end
+
+        let(:inputs) { }
+
+        subject do
+          example = OptionsExample.new
+          example.send(:mass_assign, inputs)
+          example
+        end
+
+        context ':default' do
+          context 'without a value' do
+            let(:inputs) { { two: '' } }
+
+            it 'will set the default value' do
+              expect(subject.three).to eq 'three'
+            end
+          end
+
+          context 'with a value' do
+            let(:inputs) { { two: '', three: 'one' } }
+
+            it 'will do nothing' do
+              expect(subject.three).to eq 'one'
+            end
+          end
+        end
+
+        context ':required' do
+          context 'without a value' do
+            let(:inputs) { {} }
+
+            it 'raises RequiredMissingError' do
+              expect { subject }.to raise_error RequiredMissingError
+            end
+          end
+
+          context 'with a value' do
+            let(:inputs) { { two: 'value' } }
+
+            it 'will do nothing' do
+              expect(subject.two).to eq 'value'
+            end
+          end
+        end
+
+        context ':type' do
+          context 'with wrong type' do
+            let(:inputs) { { two: 'value', four: 1 } }
+
+            it 'raises MismatchedTypeError' do
+              expect { subject }.to raise_error MismatchedTypeError
+            end
+          end
+
+          context 'with matching types' do
+            let(:inputs) { { two: 'value', four: 'a string' } }
+
+            it 'will do nothing' do
+              expect { subject }.to_not raise_error
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/simple_objects/base_spec.rb

@@ -3,12 +3,15 @@ require 'spec_helper'
 module SimpleObjects
   describe Base do
 
-    class MockObject
+    class ExampleBase
       include Base
 
-      attr_accessor :one, :two, :three
+      attribute :one
+      attribute :two
     end
 
+    subject { ExampleBase.new }
+
     describe '#initialize' do
       let(:args) do
         {
@@ -17,17 +20,12 @@ module SimpleObjects
         }
       end
 
-      subject { MockObject.new(args) }
+      subject { ExampleBase.new(args) }
 
       its(:one) { is_expected.to eq 1 }
       its(:two) { is_expected.to eq 3 }
-      its(:three) { is_expected.to be_nil }
     end
 
-    describe '#to_h' do
-      subject { MockObject.new(one: 'foo', two: 2).to_h }
-
-      it { is_expected.to include(one: 'foo', two: 2, three: nil) }
-    end
+    it { is_expected.to respond_to(:to_h) }
   end
 end

data/spec/lib/simple_objects/serialization_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+module SimpleObjects
+  describe Serialization do
+
+    class ExampleSerialization
+      include Serialization
+
+      attr_accessor :one, :two
+
+      def timestamp
+        Time.now
+      end
+
+      def attributes
+        [:one, :two]
+      end
+    end
+
+    describe '#to_h' do
+      let(:options) { {} }
+      let(:example) { ExampleSerialization.new }
+
+      subject { example.to_h(options) }
+
+      it { is_expected.to be_a Hash }
+      it { is_expected.to include(:one, :two) }
+
+      context 'with option' do
+        context ':only' do
+          let(:options) { { only: [:one] } }
+
+          it { is_expected.to_not include(:two) }
+        end
+
+        context ':except' do
+          let(:options) { { except: [:one] } }
+
+          it { is_expected.to_not include(:one) }
+        end
+
+        context ':methods' do
+          let(:options) { { methods: [:timestamp] } }
+
+          it { is_expected.to include(:timestamp) }
+        end
+      end
+
+      context 'with a collection' do
+        it 'will call .to_h on entries' do
+          example.one = [ExampleSerialization.new]
+          expect(subject[:one]).to be_a Array
+          expect(subject[:one].first).to include(:one, :two)
+        end
+      end
+
+      context 'with a value that responds to .to_h' do
+        it 'will call .to_h' do
+          example.one = ExampleSerialization.new
+
+          expect(subject[:one]).to include(:one, :two)
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_objects
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '1.0'
 platform: ruby
 authors:
 - Sean Callan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-08 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,16 +102,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/simple_objects.rb
+- lib/simple_objects/attribute.rb
+- lib/simple_objects/attributes.rb
 - lib/simple_objects/base.rb
-- lib/simple_objects/defaults.rb
+- lib/simple_objects/errors/mismatched_type_error.rb
+- lib/simple_objects/errors/required_missing_error.rb
+- lib/simple_objects/serialization.rb
 - lib/simple_objects/version.rb
 - simple_objects.gemspec
+- spec/lib/simple_objects/attribute_spec.rb
+- spec/lib/simple_objects/attributes_spec.rb
 - spec/lib/simple_objects/base_spec.rb
+- spec/lib/simple_objects/serialization_spec.rb
 - spec/spec_helper.rb
 homepage: 
 licenses:
@@ -138,5 +146,8 @@ signing_key:
 specification_version: 4
 summary: Simple objects for Ruby
 test_files:
+- spec/lib/simple_objects/attribute_spec.rb
+- spec/lib/simple_objects/attributes_spec.rb
 - spec/lib/simple_objects/base_spec.rb
+- spec/lib/simple_objects/serialization_spec.rb
 - spec/spec_helper.rb

data/lib/simple_objects/defaults.rb

@@ -1,23 +0,0 @@
-module SimpleObjects
-  module Defaults
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def attr_default(*defaults)
-        @defaults ||= {}
-        defaults.each { |default| @defaults.merge!(default) }
-      end
-
-      def defaults
-        @defaults || {}
-      end
-    end
-
-    def defaults
-      self.class.defaults
-    end
-  end
-end