define-poro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 033b78f766bc6090768bb0ab44668594d5f1e6a4
+  data.tar.gz: a9790b5fbb89d3f539594d5c80b8ee199617bf47
+SHA512:
+  metadata.gz: 8abf6b17bd0ce8384d46f373dd5af53737a7bec5691e2b4e32b6d0531fc41b18ca2e558d3f6dbfe0b7eae88b4bccffde092fc2f885a133909180b260b6724f66
+  data.tar.gz: f3774c785ce47070349f4aad8123403b72cf32d292166c9ca45991a382a03da7e0edb41ae07863310497bb8306a05b33e443288561e9295361ef622a64ab5de4

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Karolis Astrauka
+
+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,103 @@
+# Define Poro
+
+Plain Old Ruby Object class builder from provided attribute list and block.
+
+## Rationale
+
+I have been using Struct.new to dynamically create ruby objects that base their identity
+on functionality and not on values.
+
+```
+RegisterUser = Struct.new(:user, :params) do
+  # logic for registering user
+end
+```
+
+Then I looked what a Struct is: http://en.wikipedia.org/wiki/Struct_%28C_programming_language%29
+
+From ruby side http://www.ruby-doc.org/core-2.2.0/Struct.html
+
+So it is an object that acts like container for data. It implements `Enumerable`.
+But `RegisterUser` is not a data container, neither enumerable. So what is it?
+
+I would say PORO (plain old ruby object).
+
+It should be described as:
+
+```
+RegisterUser
+  attr_reader :user, :params
+
+  def initialize(user, params)
+    @user, @params = user, params
+  end
+
+  # logic for registering user
+end
+```
+
+Ruby guys are lazy so we would like to type something shorter - that's provided by DefinePoro:
+
+```
+RegisterUser = DefinePoro::Define.new(:user, :params) do
+  # logic for registering user
+end
+```
+
+The `DefinePoro::Define` implementation is easy and performant ruby code.
+
+## Should you use it?
+
+Yes - if you are lazy to type initializers.
+
+No - if you think that dynamic class definition could be harmful.
+And I believe that in some cases it could.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'define-poro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install define-poro
+
+## Usage
+
+Instead of
+
+```
+RegisterUser
+  attr_reader :user, :params
+
+  def initialize(user, params)
+    @user, @params = user, params
+  end
+
+  # logic for registering user
+end
+```
+
+Define you class via
+
+```
+RegisterUser = DefinePoro::Define.new(:user, :params) do
+  # logic for registering user
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/astrauka/define-poro/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Ensure that you have written specs (rspec)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

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

data/lib/define-poro.rb

@@ -0,0 +1,5 @@
+require 'define-poro/version'
+require 'define-poro/define'
+
+module DefinePoro
+end

data/lib/define-poro/define.rb

@@ -0,0 +1,17 @@
+module DefinePoro
+  class Define
+    def self.new(*attributes, &block)
+      Class.new do
+        class_eval(%(
+          attr_reader #{attributes.map { |a| ":#{a}" }.join(', ')}
+
+          def initialize(#{attributes.join(', ')})
+            #{attributes.map { |a| "@#{a}=#{a}" }.join('; ')}
+          end
+        ))
+
+        class_exec &block if block_given?
+      end
+    end
+  end
+end

data/lib/define-poro/version.rb

@@ -0,0 +1,3 @@
+module DefinePoro
+  VERSION = '0.0.1'
+end

data/poro.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'define-poro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'define-poro'
+  spec.version       = DefinePoro::VERSION
+  spec.authors       = ['Karolis Astrauka']
+  spec.email         = ['astrauka@gmail.com']
+  spec.summary       = %q{Plain Old Ruby Object class builder from provided attribute list.}
+  spec.description   = %q{Provides dynamic class builder given attributes that the ruby object
+    should take and class definition block.}
+  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_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/spec/lib/define_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+module DefinePoro
+  describe Define do
+    describe '.new' do
+      let(:klass) { described_class.new(:b, :a) }
+
+      describe 'class construction properties' do
+        subject { klass }
+
+        it 'extends object directly' do
+          expect(subject.ancestors[1]).to eq Object
+        end
+
+        it 'supports multiple argument accessors' do
+          expect(subject.public_instance_methods(false)).to eq %i(b a)
+        end
+
+        it 'does not clash with different class arguments' do
+          subject
+          klass2 = described_class.new(:b, :c)
+          expect(klass.public_instance_methods(false)).to eq %i(b a)
+          expect(klass2.public_instance_methods(false)).to eq %i(b c)
+        end
+
+        it 'supports block' do
+          klass2 = described_class.new(:a) do
+            def qq
+              "a is #{a}"
+            end
+
+            def self.class_qq
+              'class qq'
+            end
+          end
+
+          expect(klass2.new('1').qq).to eq 'a is 1'
+          expect(klass2.class_qq).to eq 'class qq'
+        end
+      end
+
+      describe 'object properties' do
+        subject { klass.new('b', 'a') }
+
+        it 'assigns attributes in order' do
+          expect(subject.a).to eq 'a'
+          expect(subject.b).to eq 'b'
+        end
+
+        it 'checks attributes count' do
+          expect {
+            klass.new('b')
+          }.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'define-poro'
+require 'pry'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: define-poro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Karolis Astrauka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: |-
+  Provides dynamic class builder given attributes that the ruby object
+      should take and class definition block.
+email:
+- astrauka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/define-poro.rb
+- lib/define-poro/define.rb
+- lib/define-poro/version.rb
+- poro.gemspec
+- spec/lib/define_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: Plain Old Ruby Object class builder from provided attribute list.
+test_files:
+- spec/lib/define_spec.rb
+- spec/spec_helper.rb