active_entity 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47be0a7e04d9be58924ae62eb75767f415e87e89
+  data.tar.gz: c00c8b1651220fc744e68f0fc9097ab71505df2f
+SHA512:
+  metadata.gz: 8014240c2bac204b34fbecef8cbc3f31ad4f2c353bd7d3573d89397902d1db56bf0e5c3ecdfe58eaa52a7e006b1f64608ea7a545eaf1ee92eaff0b1de7c0dd12
+  data.tar.gz: fdd4e6a0b67f756dece737e2076cf496dd02021412ff2156f8a6eda88cf5d39f3c967500b1f11b2282271ac1b9bd505bef75bdc276da00f98d594a082c37f3eb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Taiki ONO
+
+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,54 @@
+# ActiveEntity
+
+To make an entity with ease according to ActiveModel way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_entity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_entity
+
+## Synopsis
+
+```ruby
+class Message
+  include ActiveEntity::Entity
+
+  attribute :title
+  attribute :body
+
+  identity_attribute :title
+
+  validates :title, presence: true, length: { maximum: 255 }
+  validates :body, presence: true
+end
+
+message = Message.new(title: 'A README of ActiveEntity')
+message.valid? #=> false
+message.errors #=> returns a ActiveModel::Errors
+
+message = Message.new(title: 'A README of ActiveEntity', body: 'No contents!')
+message.valid? #=> true
+message.attributes #=> { title: "A README of ActiveEntity", body: "No contents!" }
+
+another_messsage = Message.new(title: 'A README of ActiveEntity', body: '')
+message == another_messsage #=> true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/taiki45/active_entity/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

data/Rakefile

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

data/active_entity.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_entity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_entity"
+  spec.version       = ActiveEntity::VERSION
+  spec.authors       = ["Taiki ONO"]
+  spec.email         = ["taiki-ono@cookpad.com"]
+  spec.summary       = %q{To make an entity with ease according to ActiveModel way.}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "activemodel", ">= 4.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+end

data/lib/active_entity.rb

@@ -0,0 +1,9 @@
+require 'active_model'
+require 'active_support/concern'
+
+require 'active_entity/version'
+require 'active_entity/attribute'
+require 'active_entity/identity'
+require 'active_entity/strict_assignment'
+require 'active_entity/entity'
+require 'active_entity/mutability'

data/lib/active_entity/attribute.rb

@@ -0,0 +1,32 @@
+module ActiveEntity
+  module Attribute
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :defined_attributes,
+        instance_writer: false, instance_predicate: false
+      self.defined_attributes = {}
+    end
+
+    class_methods do
+      def attribute(name, options = {})
+        defined_attributes[name] = options
+        attr_reader(name)
+      end
+    end
+
+    def initialize(attrs = {})
+      attrs.each do |attr, value|
+        instance_variable_set(:"@#{attr}", value)
+      end if attrs.respond_to?(:each)
+
+      super()
+    end
+
+    def attributes
+      @_attributes ||= begin
+        Hash[defined_attributes.keys.map {|name| [name, public_send(name)] }]
+      end
+    end
+  end
+end

data/lib/active_entity/entity.rb

@@ -0,0 +1,13 @@
+module ActiveEntity
+  module Entity
+    extend ActiveSupport::Concern
+
+    included do
+      include Attribute
+      include StrictAssignment
+      include Identity
+      include ActiveModel::Validations
+      include ActiveModel::Serialization
+    end
+  end
+end

data/lib/active_entity/identity.rb

@@ -0,0 +1,30 @@
+module ActiveEntity
+  module Identity
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :identity_attributes,
+        instance_writer: false, instance_predicate: false
+      self.identity_attributes = []
+    end
+
+    class_methods do
+      def identity_attribute(*names)
+        identity_attributes.concat(names.flatten)
+
+        define_method(:==) do |other|
+          return false unless self.class === other
+
+          names.all? do |name|
+            public_send(name) == other.public_send(name)
+          end
+        end
+      end
+    end
+
+    # For ActiveModel::Conversion
+    def to_key
+      indentity_attributes.empty? ? nil : identity_attributes
+    end
+  end
+end

data/lib/active_entity/mutability.rb

@@ -0,0 +1,16 @@
+module ActiveEntity
+  module Mutability
+    extend ActiveSupport::Concern
+
+    included do
+      attr_writer(*defined_attributes.keys)
+    end
+
+    class_methods do
+      def attribute(name, option = {})
+        super
+        attr_writer(name)
+      end
+    end
+  end
+end

data/lib/active_entity/strict_assignment.rb

@@ -0,0 +1,15 @@
+module ActiveEntity
+  module StrictAssignment
+    extend ActiveSupport::Concern
+
+    def initialize(attrs = {})
+      keys = attrs.keys.map(&:to_sym) - defined_attributes.keys
+
+      unless keys.empty?
+        raise ArgumentError.new("Invalid assignments on: #{keys}")
+      end
+
+      super
+    end
+  end
+end

data/lib/active_entity/version.rb

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

data/spec/active_entity/attribute_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe ActiveEntity::Attribute do
+  let(:test_class) do
+    Class.new do
+      include ActiveEntity::Attribute
+
+      attribute :name
+      attribute :age
+    end
+  end
+
+  let(:test_attributes) { { name: 'Alice', age: 1 } }
+
+  describe '.defined_attributes' do
+    subject { test_class.defined_attributes }
+    it { is_expected.to be_kind_of(Hash) }
+
+    it 'returns all defined attributes' do
+      is_expected.to eq(name: {}, age: {})
+    end
+  end
+
+  describe '#initialize' do
+    subject { test_class.new(test_attributes) }
+
+    it 'assigns attributes' do
+      expect(subject.name).to eq('Alice')
+      expect(subject.age).to eq(1)
+    end
+  end
+
+  describe '#attributes' do
+    subject { test_class.new(test_attributes).attributes }
+
+    it { is_expected.to be_kind_of(Hash) }
+
+    it "returns all attribute's name-value pairs" do
+      is_expected.to eq(name: 'Alice', age: 1)
+    end
+  end
+end

data/spec/active_entity/identity_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe ActiveEntity::Identity do
+  let(:test_class) do
+    Class.new do
+      include ActiveEntity::Identity
+
+      attr_reader :name, :age
+      identity_attribute :name, :age
+
+      def initialize(name, age)
+        @name = name
+        @age = age
+      end
+    end
+  end
+
+  describe '.identity_attributes' do
+    subject { test_class.identity_attributes }
+    it { is_expected.to eq([:name, :age]) }
+  end
+
+  describe '#==' do
+    subject { a == b }
+    let(:a) { test_class.new('Alice', 1) }
+
+    context 'with same entity' do
+      let(:b) { test_class.new('Alice', 1) }
+      it { is_expected.to be_truthy }
+    end
+
+    context 'with different entity' do
+      context 'and it has all different attributes' do
+        let(:b) { test_class.new('Bob', 2) }
+        it { is_expected.to be_falsey }
+      end
+
+      context 'and it has some of different attributes' do
+        let(:b) { test_class.new('Alice', 2) }
+        it { is_expected.to be_falsey }
+      end
+    end
+  end
+end

data/spec/active_entity/mutability_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe ActiveEntity::Mutability do
+  subject { test_class.new(x: 1) }
+
+  context 'when included after attribute definitions' do
+    before { test_class.send(:include, ActiveEntity::Mutability) }
+
+    let(:test_class) do
+      Class.new do
+        include ActiveEntity::Attribute
+        attribute :x
+      end
+    end
+
+    it 'accepts attribute assign' do
+      expect { subject.x = 0 }.not_to raise_error
+      expect(subject.x).to eq(0)
+    end
+  end
+
+  context 'when included before attribute definitions' do
+    let(:test_class) do
+      Class.new do
+        include ActiveEntity::Attribute
+        include ActiveEntity::Mutability
+        attribute :x
+      end
+    end
+
+    it 'accepts attribute assign' do
+      expect { subject.x = 0 }.not_to raise_error
+      expect(subject.x).to eq(0)
+    end
+  end
+end

data/spec/active_entity/strict_assignment_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.describe ActiveEntity::StrictAssignment do
+  let(:test_class) do
+    Class.new do
+      include ActiveEntity::Attribute
+      include ActiveEntity::StrictAssignment
+
+      attribute :name
+    end
+  end
+
+  describe '#initialize' do
+    context 'with valid mass assignment' do
+      it 'does not raise anything' do
+        expect { test_class.new(name: 'Alice') }.not_to raise_error
+      end
+    end
+
+    context 'with forbidden mass assignment' do
+      it 'raises ArgumentError' do
+        expect { test_class.new(x: 'x') }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'pry'
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_entity'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: active_entity
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Taiki ONO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: To make an entity with ease according to ActiveModel way.
+email:
+- taiki-ono@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_entity.gemspec
+- lib/active_entity.rb
+- lib/active_entity/attribute.rb
+- lib/active_entity/entity.rb
+- lib/active_entity/identity.rb
+- lib/active_entity/mutability.rb
+- lib/active_entity/strict_assignment.rb
+- lib/active_entity/version.rb
+- spec/active_entity/attribute_spec.rb
+- spec/active_entity/identity_spec.rb
+- spec/active_entity/mutability_spec.rb
+- spec/active_entity/strict_assignment_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:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: To make an entity with ease according to ActiveModel way.
+test_files:
+- spec/active_entity/attribute_spec.rb
+- spec/active_entity/identity_spec.rb
+- spec/active_entity/mutability_spec.rb
+- spec/active_entity/strict_assignment_spec.rb
+- spec/spec_helper.rb
+has_rdoc: