mochening 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mochening.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Benny Hallett
+
+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 @@
+# Mochening
+
+TODO: Write a gem description
+Mochening makes it easy to define expectations and stubs for your database when using Sequel
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mochening'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mochening
+
+## Usage
+
+Mochening allows you to easily use Mocha to mock the calls onto a Sequel database object.
+
+The common pattern of usage is:
+
+    Mochening::Expect.from(mock_database) do |db|
+      db[:table].where(a: 'a', b: 'b').select(:c, :d).all [{ c: '1', d: '1' }, { c: '2', d: '2' }]
+    end
+
+
+In the above example, we're given a Mocha mock object, and inside the block we're easily able to apply expectations to the database in the same style that the Sequel database object is called.
+
+The `.all` and `.first` methods expect that a return value is provided, so that Mochening knows what it should return when the method is called.
+
+## Available Sequel methods
+
+At the moment, only a subset of Sequel functionality is able to be mocked. Only expectations are able to be set at this time, but stubs are planned for the future.
+
+**Expectations**
+
+* [:table_name]
+* where
+* select
+* insert
+* all
+* first
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc "Run the specs."
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/lib/mochening.rb

@@ -0,0 +1,43 @@
+require "mochening/version"
+
+module Mochening
+  class Expect
+    def self.from(db)
+      raise "Cannot expect anything from a nil database" if db.nil?
+      raise "Expected a block" unless block_given?
+      yield Mochening::Expect.new(db)
+    end
+
+    def initialize(db)
+      @db = db
+    end
+
+    def [](table)
+      @db.expects(:[]).with(table)
+      self
+    end
+
+    def where(restriction)
+      @db.expects(:where).with(restriction)
+      self
+    end
+
+    def select(*columns)
+      @db.expects(:select).with(*columns)
+      self
+    end
+
+    def insert(value)
+      @db.expects(:insert).with(value)
+      self
+    end
+
+    def all(return_value)
+      @db.expects(:all).returns(return_value)
+    end
+
+    def first(return_value)
+      @db.expects(:first).returns(return_value)
+    end
+  end
+end

data/lib/mochening/version.rb

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

data/mochening.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mochening/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mochening"
+  spec.version       = Mochening::VERSION
+  spec.authors       = ["Benny Hallett"]
+  spec.email         = ["benny.hallett@gmail.com"]
+  spec.description   = %q{Mochening allows simpler mocking of Sequel database objects with Mocha.}
+  spec.summary       = %q{Mochening makes mocking Sequel database objects with Mocha simpler}
+  spec.homepage      = "http://github.com/bennyhallett/mochening"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-mocks'
+end

data/spec/mochening_spec.rb

@@ -0,0 +1,93 @@
+require 'mochening'
+
+describe Mochening do
+  it "raises error when called with nil database" do
+    expect { Mochening::Expect.from(nil) }.to raise_error(RuntimeError)
+  end
+
+  it "raises error when called without a block" do
+    db = double('database')
+    expect { Mochening::Expect.from(db) }.to raise_error(RuntimeError)
+  end
+
+  it "sets an expectation on the db that a dataset is created" do
+    db = double('database')
+    expect(db).to receive(:expects).with(:[]).and_return(db)
+    expect(db).to receive(:with).with(:table)
+
+    Mochening::Expect.from(db) do |dbase|
+      dbase[:table]
+    end
+  end
+
+  it "sets an expectation on the db that the dataset is restricted to a set of values" do
+    restriction = { a: 'a', b: 'b' }
+    db = double('database')
+    expect(db).to receive(:expects).with(:[]).and_return(db)
+    expect(db).to receive(:with).with(:table).and_return(db)
+    expect(db).to receive(:expects).with(:where).and_return(db)
+    expect(db).to receive(:with).with(restriction)
+
+    Mochening::Expect.from(db) do |dbase|
+      dbase[:table].where(a: 'a', b: 'b')
+    end
+  end
+
+  it "sets an expectations on the db that a set of values is selected from the dataset" do
+    db = double('database')
+    expect(db).to receive(:expects).with(:[]).and_return(db)
+    expect(db).to receive(:with).with(:table).and_return(db)
+    expect(db).to receive(:expects).with(:select).and_return(db)
+    expect(db).to receive(:with).with(:a, :b)
+
+    Mochening::Expect.from(db) do |dbase|
+      dbase[:table].select(:a, :b)
+    end
+  end
+
+  it "sets an expectation on the db that a set of values in inserted into the table" do
+    db = double('database')
+    expect(db).to receive(:expects).with(:[]).and_return(db)
+    expect(db).to receive(:with).with(:table).and_return(db)
+    expect(db).to receive(:expects).with(:insert).and_return(db)
+    expect(db).to receive(:with).with({ a: 'a', b: 'b' })
+
+    Mochening::Expect.from(db) do |dbase|
+      dbase[:table].insert({ a: 'a', b: 'b' })
+    end 
+  end
+
+  it "returns all values of a selected data set" do
+    return_value = [ { a: 'aa', b: 'bb' }, { a: '12', b: '34' } ]
+
+    db = double('database')
+    expect(db).to receive(:expects).with(:[]).and_return(db)
+    expect(db).to receive(:with).with(:table)
+    expect(db).to receive(:expects).with(:where).and_return(db)
+    expect(db).to receive(:with).with(c: 'c')
+    expect(db).to receive(:expects).with(:select).and_return(db)
+    expect(db).to receive(:with).with(:a, :b)
+    expect(db).to receive(:expects).with(:all).and_return(db)
+    expect(db).to receive(:returns).with(return_value)
+
+    Mochening::Expect.from(db) do |dbase|
+      dbase[:table].where(c: 'c').select(:a, :b).all return_value
+    end
+  end
+
+  it "returns first value of a selected data set" do
+    return_value = { a: 'aa', b: 'bb', c: 'c' }
+
+    db = double('database')
+    expect(db).to receive(:expects).with(:[]).and_return(db)
+    expect(db).to receive(:with).with(:table)
+    expect(db).to receive(:expects).with(:where).and_return(db)
+    expect(db).to receive(:with).with(c: 'c')
+    expect(db).to receive(:expects).with(:first).and_return(db)
+    expect(db).to receive(:returns).with(return_value)
+
+    Mochening::Expect.from(db) do |dbase|
+      dbase[:table].where(c: 'c').first return_value
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: mochening
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benny Hallett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mochening allows simpler mocking of Sequel database objects with Mocha.
+email:
+- benny.hallett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mochening.rb
+- lib/mochening/version.rb
+- mochening.gemspec
+- spec/mochening_spec.rb
+homepage: http://github.com/bennyhallett/mochening
+licenses:
+- MIT
+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: Mochening makes mocking Sequel database objects with Mocha simpler
+test_files:
+- spec/mochening_spec.rb