mumm_ra 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b56116cf0c2f38ffcd33d47713b225d1aa2ce32c
+  data.tar.gz: b1f7bbdb0ea444cd3d8607fe4b05f19ee16b4f79
+SHA512:
+  metadata.gz: 9649adfde955122dd05b9b1518fbb864aae28bfd9d785ec45b0e1e8a7772c7e28d6ae87440918277dd1a27bd41aee44c7e8e55cefc6eda9887d445b30fb73976
+  data.tar.gz: 8ada7bdf511d8b487a4b744790b39b60039fdc0e91b5b462779158828664ed0e85367eea4b2cb1fba37d86b34a744e634377516070542334924d9eace095d090

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/README.html

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Federico Iachetti
+
+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.org

@@ -0,0 +1,60 @@
+* MummRa
+[[https://travis-ci.org/iachettifederico/mumm_ra][Build State]] [[https://travis-ci.org/iachettifederico/mumm_ra.svg]]
+
+This gem implements a simple Repository. It's ment to retrieve data from a source in a uniform way.
+
+It's called after a cartoon character from the Thundercats show. This character is a wizard mummy with limited powers, but has the ability to turn itself into a powerful enemy with the help of ancient spirits.
+
+It takes the analogy of simple mummy (raw data in the source) and powerful entity (fully quallified Ruby objects).
+
+** Introduction
+
+Say we have some data stored in a source. The data takes the form of two dimentional points, that has an =x= field and a =y= field.
+
+We want to make a Repository capable of retreiving the stored data, allowing us not to worry about the output data.
+
+This =Repository= should be placed between the ORM and Business layers of an application.
+
+** Preconditions
+*** The mapped object should comply with the following rules:
+- It should be able to be initialized via a =Hash=
+- It's class should have a =#members= method, that returns an array (or =Enumerable=) with the mane of the attributes as it's items (in the form of a =String= or =Symbol=)
+- It has to have getters for every member
+
+This behaviour could be easily achieved using the [[http://github.com/iachettifederico/rb_toolbox][rb_toolbox]] gem.
+
+*** The source should comply with the following
+- It should respond to the =#values= method, which sould return all the "stored" objects
+- It should respond to the =#[]= method that, sould receive a key and return it's corresponding value
+
+This behaviour could be easily achieved using a =Hash=.
+
+*** Usage
+
+TODO: Complete usage
+
+** Installation
+
+Add this line to your application's Gemfile:
+
+#+BEGIN_SRC ruby
+gem 'mumm_ra'
+#+END_SRC
+
+And then execute:
+#+BEGIN_SRC bash
+$ bundle
+#+END_SRC
+
+Or install it yourself as:
+#+BEGIN_SRC bash
+$ gem install mumm_ra
+#+END_SRC
+
+** Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mumm_ra/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,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mumm_ra/repository.rb

@@ -0,0 +1,39 @@
+module MummRa
+  class Repository
+    include Enumerable
+
+    def initialize(args={})
+      @source     = args.fetch(:source)
+      @main_class = args.fetch(:main_class)
+    end
+
+    def all
+      @all ||= source.values
+    end
+
+    def each
+      all.each do |value|
+        yield value
+      end
+    end
+
+    def [](key)
+      source[key]
+    end
+
+    def construct_from_object(obj)
+      return obj if obj.is_a? main_class
+      return main_class.new(obj) if obj.is_a?(Hash)
+      attrs = {}
+      main_class.members.each do |attr|
+        attrs[attr] = obj.send(attr)
+      end
+      main_class.new(attrs)
+    end
+
+    private
+    attr_reader :source
+    attr_reader :main_class
+
+  end
+end

data/lib/mumm_ra/version.rb

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

data/lib/mumm_ra.rb

@@ -0,0 +1,5 @@
+require "mumm_ra/version"
+require "mumm_ra/repository"
+
+module MummRa
+end

data/mumm_ra.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mumm_ra/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mumm_ra"
+  spec.version       = MummRa::VERSION
+  spec.authors       = ["Federico Iachetti"]
+  spec.email         = ["iachetti.federico@gmail.com"]
+  spec.summary       = %q{Provides a way to access data via a Repository object.}
+  spec.description   = %q{Provides a way to access data via a Repository object.}
+  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 "rb_toolbox"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.12"
+  spec.add_development_dependency "rspec-given", "~> 3.5.4"
+end

data/spec/mumm_ra/repository_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+require "mumm_ra/repository"
+require "ostruct"
+require "rb_toolbox/struct"
+
+Point = RbToolbox::Struct.new(:x, :y)
+
+module MummRa
+  describe Repository do
+    context "initialization" do
+      context "with source and main_class" do
+        When(:repo) { Repository.new(source: :source, main_class: :main_class) }
+        Then { expect(repo).not_to have_failed }
+      end
+
+      context "without source" do
+        When(:repo) { Repository.new(main_class: :main_class) }
+        Then { expect(repo).to have_failed(KeyError, "key not found: :source") }
+      end
+
+      context "without main_class" do
+        When(:repo) { Repository.new(source: :source) }
+        Then { expect(repo).to have_failed(KeyError, "key not found: :main_class") }
+      end
+    end
+
+    context "enumeration" do
+      Given(:repo) { Repository.new(source: source, main_class: nil) }
+      Given(:source) {
+        {
+          "one"   => "One",
+          "two"   => "Two",
+          "three" => "Three",
+        }
+      }
+      Given(:values) { %W[One Two Three] }
+      Then { repo.all == values }
+      Then {
+        repo.each do |value|
+          value == values.shift
+        end
+      }
+      Then { repo.is_a? Enumerable }
+    end
+
+
+    context "fetching and constructing" do
+      Given(:main_class) { Point }
+      Given(:first)  { Point.new(x: 0, y: 0) }
+      Given(:second) { Point.new(x: 1, y: 1) }
+      Given(:source) {
+        {
+          "first"  => first,
+          "second" => second,
+        }
+      }
+      Given(:repo) { Repository.new(source: source, main_class: main_class) }
+
+      context "#[]" do
+        Then { repo["first"] == first }
+        Then { repo["third"] == nil }
+      end
+
+      context "#construct_from_object" do
+        #Invariable { repo.construct_from_object.is_a?(main_class) }
+        Given(:point)  { Point.new(x: 1, y: 2) }
+        Given(:hash)   { {x: 3, y: 4} }
+        Given(:object) { OpenStruct.new(x: 5, y: 6) }
+
+        When(:point1) { repo.construct_from_object(point) }
+        When(:point2) { repo.construct_from_object(hash) }
+        When(:point3) { repo.construct_from_object(object) }
+
+        Then { point1.is_a? Point }
+        Then { point1.x == 1 }
+        Then { point1.y == 2 }
+
+        Then { point2.is_a? Point }
+        Then { point2.x == 3 }
+        Then { point2.y == 4 }
+
+        Then { point3.is_a? Point }
+        Then { point3.x == 5 }
+        Then { point3.y == 6 }
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "rspec/given"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: mumm_ra
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Federico Iachetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_toolbox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.4
+description: Provides a way to access data via a Repository object.
+email:
+- iachetti.federico@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.org
+- Rakefile
+- lib/mumm_ra.rb
+- lib/mumm_ra/repository.rb
+- lib/mumm_ra/version.rb
+- mumm_ra.gemspec
+- spec/mumm_ra/repository_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: Provides a way to access data via a Repository object.
+test_files:
+- spec/mumm_ra/repository_spec.rb
+- spec/spec_helper.rb