yockeries 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Robert Evans
+
+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.rdoc

@@ -0,0 +1,62 @@
+= Yockeries - Yaml + Mocks + Factories(easy way to create them)
+
+Long ago there was an uprising against YAML fixtures in the rails world. Some
+people replaced them with things like FactoryGirl, Machinist, Fabrication, and a
+bunch of others.
+
+However, YAML is still the simpliest thing that works, because it comes with
+Ruby. When you load in a yaml file with YAML.load_file, the yaml data is
+converted into a hash, which again is simple to use and test. You can take
+that hash and create a new object with it: Person.new(yaml_converted_hash),
+you can use it to create a stand-in double/mock:
+OpenStruct.new(yaml_converted_hash).
+
++Yockeries+ is meant to make that a tiny bit simplier with a
+small amount of code.
+
++Yockeries+ gives a convienent yaml loader (smart enough to know if you are
+using rspec, minitest, or testunit) to load an entire fixture file into a hash
+and then use the +get+ method to select which yaml object you want to work
+with.
+
+There is also a method +mock_for+ that will create an +OpenStruct+ object where
+you can create a very simple test +double/mock+.
+
+
+=== YAML File (people.yaml)
+
+  robert:
+   name: Robert Evans
+   email: robert@example.com
+   username: revans
+   password: 123456
+   password_confirmation: 123456
+
+
+
+== Examples:
+
+=== Load a specific User from a YAML File
+
+  fixture(:people).get(:robert) # => {:name=>"Robert Evans", :email=>"robert@example.com", :username=>"revans", :password=>123456, :password_confirmation=>123456}
+
+
+=== Load a mock Object from the YAML file
+
+  fixture(:people).mock_for(:robert) #=> #<OpenStruct name="Robert Evans", email="robert@example.com", username="revans", password=123456, password_confirmation=123456>
+
+=== Real world example with testunit:
+
+  assert_difference "Person.count", 1 do
+   Person.new(
+     fixture(:people).get(:robert)
+   )
+  end
+
+=== Real world example with rspec
+
+  expect {
+   Person.new(
+     fixture(:people).get(:robert)
+   ).save
+  }.to change { Person.count }.by(1)

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :test do
+  system "ruby", "-Itest", "test/yockeries_test.rb"
+end

data/lib/yockeries.rb

@@ -0,0 +1,65 @@
+require 'yaml'
+require 'ostruct'
+
+module Yockeries
+  class YockHash < Hash
+    def initialize(hash = {})
+      @hash = symbolize_keys(hash)
+    end
+
+    def get(name)
+      @hash[name.to_sym]
+    end
+
+    def mock_for(name)
+      OpenStruct.new(get(name))
+    end
+
+    private
+
+    def symbolize_keys(hash)
+      case hash
+      when Array
+        symbolize_array_keys(hash)
+      when Hash
+        symbolize_hash_keys(hash)
+      else
+        hash
+      end
+    end
+
+    def symbolize_array_keys(array)
+      array.inject([]) do |result, value|
+        result << case value
+        when Hash, Array
+          symbolize_keys(value)
+        else
+          value
+        end
+        result
+      end
+    end
+
+    def symbolize_hash_keys(hash)
+      hash.inject({}) do |result, (key,value)|
+        nval = case value
+        when Hash, Array
+          symbolize_keys(value)
+        else
+          value
+        end
+        result[key.to_sym] = nval
+        result
+      end
+    end
+
+  end
+
+
+  module Loader
+    def fixture(filename)
+      dir = File.exists?('test') ? 'test' : 'spec'
+      ::Yockeries::YockHash.new(YAML.load_file("#{dir}/fixtures/#{filename.to_s}.yaml"))
+    end
+  end
+end

data/test/yockeries_test.rb

@@ -0,0 +1,33 @@
+require 'minitest/autorun'
+require_relative '../lib/yockeries'
+
+module Yockeries
+  describe YockHash do
+    let(:hash) do
+      { 'user_1' => { 'name' => 'robert', 'email' => 'robert@example.com' },
+        'user_2' => { 'name' => 'tyler',  'email' => 'ty@example.com' } }
+    end
+
+    subject { YockHash.new(hash) }
+
+    it 'symbolizes the keys' do
+      subject.get('user_1').key?(:name).must_equal true
+    end
+
+    it 'will return the name for user_1' do
+      subject.get('user_1')[:name].must_equal 'robert'
+    end
+
+    it 'will return the name for user_2' do
+      subject.get('user_2')[:name].must_equal 'tyler'
+    end
+
+    it 'will return a mock' do
+      subject.mock_for('user_1').kind_of?(OpenStruct).must_equal true
+    end
+
+    it 'mocks will imitate an object' do
+      subject.mock_for('user_1').name.must_equal 'robert'
+    end
+  end
+end

data/yockeries.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "yockeries"
+  gem.version       = '0.0.1'
+  gem.authors       = ["Robert Evans"]
+  gem.email         = ["robert@codewranglers.org"]
+  gem.description   = %q{Use Ruby Fixtures to create mocks or use in place of factories to create objects}
+  gem.summary       = %q{Use Ruby Fixtures to create mocks or use in place of factories to create objects}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: yockeries
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Robert Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-04 00:00:00.000000000 Z
+dependencies: []
+description: Use Ruby Fixtures to create mocks or use in place of factories to create
+  objects
+email:
+- robert@codewranglers.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/yockeries.rb
+- test/yockeries_test.rb
+- yockeries.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Use Ruby Fixtures to create mocks or use in place of factories to create
+  objects
+test_files:
+- test/yockeries_test.rb