entity_rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49b12775d7fcb0ae8b817244f35ab6933ad7de58
+  data.tar.gz: fa53e6f2c2aa14712ae617aa820a6957e6e3e5df
+SHA512:
+  metadata.gz: 7feb84d0e330717f23c5a983df7b8591e1e9c1d7319d710fb6a3b72294055652759d091a8d686a4c46edf7fe94c97cb949fd079b8c7b0dfba98ae4d3b528e435
+  data.tar.gz: ed29751458490a55d778e8066eace696a9019703fd3f5503325adde92d9ddc9d2e0980c21c1a3c17ce31057f6d4d4a701b40ab9c724064b0b01f4ff5bc1cfdcf

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+*.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

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 entity.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Caio Torres
+
+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,31 @@
+# Entity
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'entity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install entity
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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/entity_rb.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'entity_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "entity_rb"
+  spec.version       = Entity::VERSION
+  spec.authors       = ["Caio Torres e Paulo Patto"]
+  spec.email         = ["caio.a.torres@gmail.com"]
+  spec.summary       = %q{An Entity implementation to store all business logic from the (so called) model.}
+  spec.description   = %q{An Entity implementation in ruby to store all business logic from the (so called) model.}
+  spec.homepage      = "https://github.com/efreesen/entity_rb"
+  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{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/lib/entity_rb.rb

@@ -0,0 +1,5 @@
+require "entity_rb/version"
+require "entity_rb/base"
+
+module Entity
+end

data/lib/entity_rb/base.rb

@@ -0,0 +1,29 @@
+module Entity
+  class Base
+    @@fields = []
+
+    def initialize(attributes={})
+      attributes.each do |key, value|
+        send("#{key}=", value) if @@fields.include? key.to_sym
+      end
+    end
+
+    protected
+    def self.field(key)
+      raise ArgumentError.new('Key must be a String, Symbol or Array') unless [String, Symbol, Array].include? key.class
+
+      if key.is_a? Array
+        key.each do |k|
+          begin
+            self.field k
+          rescue ArgumentError
+          end
+        end
+      else
+        @@fields.push key.to_sym
+
+        attr_accessor key.to_sym
+      end
+    end
+  end
+end

data/lib/entity_rb/version.rb

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

data/spec/entity/base_spec.rb

@@ -0,0 +1,96 @@
+require './lib/entity/base'
+
+describe Entity::Base do
+  describe '.field' do
+    before do
+      class Test < Entity::Base
+      end
+    end
+
+    subject { Test.new }
+
+    context 'when key is passed' do
+      context 'and is a Symbol' do
+        before { Test.field :test_field }
+
+        it 'defines an attribute reader for it' do
+          expect(subject).to respond_to(:test_field)
+        end
+
+        it 'defines an attribute writer for it' do
+          expect(subject).to respond_to(:test_field=)
+        end
+      end
+
+      context 'and is a String' do
+        before { Test.field 'test_field' }
+
+        it 'defines an attribute reader for it' do
+          expect(subject).to respond_to(:test_field)
+        end
+
+        it 'defines an attribute writer for it' do
+          expect(subject).to respond_to(:test_field=)
+        end
+      end
+
+      context 'and is an Fixnum' do
+        it 'raises an ArgumentError' do
+          expect{Test.field 1}.to raise_error(ArgumentError)
+        end
+      end
+
+      context ', key is an Array' do
+        context 'and all elements are supported' do
+          before { Test.field ['field1', 'field2'] }
+
+          it 'creates an attribute reader for each attribute in array' do
+            expect(subject).to respond_to(:field1)
+            expect(subject).to respond_to(:field2)
+          end
+
+          it 'creates an attribute writer for each attribute in array' do
+            expect(subject).to respond_to(:field1=)
+            expect(subject).to respond_to(:field2=)
+          end
+        end
+
+        context 'and some elements are not supported' do
+          before { Test.field [1, 'field1', 2, 'field2'] }
+
+          it 'creates an attribute reader for the valid attributes' do
+            expect(subject).to respond_to(:field1)
+            expect(subject).to respond_to(:field2)
+          end
+
+          it 'does not create an attribute reader for the invalid attributes' do
+            expect(subject).not_to respond_to(:'1')
+            expect(subject).not_to respond_to(:'2')
+          end
+
+          it 'creates an attribute writer for the valid attributes' do
+            expect(subject).to respond_to(:field1=)
+            expect(subject).to respond_to(:field2=)
+          end
+
+          it 'does not create an attribute writer for the invalid attributes' do
+            expect(subject).not_to respond_to(:'1=')
+            expect(subject).not_to respond_to(:'2=')
+          end
+        end
+      end
+
+      context 'and is a Hash' do
+        it 'raises an ArgumentError' do
+          expect{Test.field({})}.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    context 'when key is not passed' do
+      it 'raises an ArgumentError' do
+        expect{Test.field}.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+RSpec.configure do |config|
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+
+    mocks.verify_partial_doubles = true
+    mocks.verify_doubled_constant_names = true
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: entity_rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Caio Torres e Paulo Patto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 00:00:00.000000000 Z
+dependencies:
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: An Entity implementation in ruby to store all business logic from the
+  (so called) model.
+email:
+- caio.a.torres@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- entity_rb.gemspec
+- lib/entity_rb.rb
+- lib/entity_rb/base.rb
+- lib/entity_rb/version.rb
+- spec/entity/base_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/efreesen/entity_rb
+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: An Entity implementation to store all business logic from the (so called)
+  model.
+test_files:
+- spec/entity/base_spec.rb
+- spec/spec_helper.rb