bogusdb 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e3d1c157db10e23b2e98c90a224e08d811ddeee
+  data.tar.gz: 5c338ab15a1c7307a7c7360fd6bebc4a070bb3cf
+SHA512:
+  metadata.gz: da134c1387cae6e15c3d6af75e0a34cb9a9b1c29059161d0be17a778852c070fb914df22f81dcb31fd228d87ff4a120951678428ab0eed7909df8db0525ea57e
+  data.tar.gz: f72155774a43954fa5361a4a2c1004c00a287e6429336d8463e544b4162fc0875972d55406100f58319167143a1797042ae98c30b1aafd6814709bd880a59665

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bradley Smith
+
+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,90 @@
+# Bogusdb
+
+`Bogusdb` is a `fake` ORM database object--Nothing more, nothing less.
+There are great tools out there that do the similar things--and do it much better.  If you need more
+features you are probably better off using one of those.
+The problem is most require heavy dependencies with them.  Also, most tools assume you are using active record and or in a rails environment.  
+
+`Bogusdb` can be used in tests where you do not want to actually create any data, 
+ but need to `unit` test your logic against a object that quacks like a ORM object.
+ 
+
+* I use this when testing daemons that have DB dependencies
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bogusdb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bogusdb
+
+## Usage
+
+So, lets say you need a table named `:user` with these column names and values
+```
+first_name: 'foo'
+last_name: 'bar'
+```
+
+## Create a row 
+* Note the id is optional
+
+```ruby
+@user = Bogusdb::Record.new(id: 10, first_name: 'foo', last_name: 'bar')
+@user.id         #=> 10
+@user.first_name #=> 'foo'
+@user.last_name  #=> 'bar'
+@user.attributes #=> {:last_name=>"bar", :id=>10, :first_name=>"foo"}
+@user.inspect    #=> "#<Bogusdb::Record: last_name: bar, id: 10, first_name: foo"
+```
+
+## Create multiple records at the same time
+```ruby
+@user = Bogusdb::Record.create([ { first_name: 'foo', last_name: 'bar' },
+                                 { first_name: 'Fizz', last_name: 'Buzz' } ])
+@user   #=> [#<Bogusdb::Record: id: 10, first_name: 'foo', last_name: 'bar', 
+             #<Bogusdb::Record: id: 23, first_name: 'Fizz', last_name: 'Buzz']
+```
+
+## Join table
+```ruby
+@user = Bogusdb::Record.new(first_name: 'foo', last_name: 'bar')
+@user.join_table(:profile, {id: 1, avatar: 'image.jpg', gender: 'M'})
+@user.profile            #=>  #<Bogusdb::Record: avatar: image.jpg, id: 1, gender: m
+@user.profile.attributes #=> {id: 1, avatar: 'image.jpg', gender: 'M'}
+```
+
+## Join a table with more familiar syntax
+```ruby
+@user = Bogusdb::Record.new(first_name: 'foo', last_name: 'bar')
+@user.has_one(:profile, {id: 1, avatar: 'image.jpg', gender: 'M'})
+@user.profile            #=>  #<Bogusdb::Record: avatar: image.jpg, id: 1, gender: m
+@user.profile.attributes #=> {id: 1, avatar: 'image.jpg', gender: 'M'}
+```
+
+```ruby
+@user = Bogusdb::Record.new(id: 10, first_name: 'foo', last_name: 'bar')
+@user.has_many(:addresses, [{street: '123 main', city: 'Denver'},
+                            {street: '456 boulder dr', city: 'Boulder'}])
+
+@user.addresses #=>  [#<Bogusdb::Record: street: '123 main', city: 'Denver', 
+                      #<Bogusdb::Record:  street: '456 boulder dr', city: 'Boulder']
+```
+
+
+
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.options = "-v"
+  t.libs << "test"
+  t.test_files = FileList["test/*_test.rb"]
+end

data/bogusdb.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bogusdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bogusdb"
+  spec.version       = Bogusdb::VERSION
+  spec.authors       = ["Bradley Smith"]
+  spec.email         = ["bradleydsmith@gmail.com"]
+  spec.description   = %q{ A simple fake database object for testing }
+  spec.summary       = %q{A simple fake ORM databsase object used in testing}
+  spec.homepage      = "https://github.com/bradleyd/bogusdb.git"
+  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 "minitest"
+  spec.add_development_dependency "mocha"
+end

data/lib/bogusdb.rb

@@ -0,0 +1,5 @@
+require "bogusdb/version"
+require "bogusdb/record"
+
+module Bogusdb
+end

data/lib/bogusdb/record.rb

@@ -0,0 +1,82 @@
+require "securerandom"
+
+module Bogusdb
+  # simulate a basic database record ORM style
+  # @param [Hash] table_data column names and values
+  class Record
+    def initialize(table_data)
+      raise TypeError unless Hash(table_data)
+      @table_data = table_data
+      set_id
+      @attributes = initialize_attributes(@table_data)
+    end
+
+    # @note can pass array of hashes to build records
+    # @param [Array, Hash] args
+    # @retrun [Array, Bogusdb::Record] 
+    def self.create(args)
+      args.is_a?(Array) ? Array.new(args.length) { |i| new(args[i]) } : new(args)
+    end
+
+    def attributes
+      @attributes
+    end
+
+    # @param  [String, Symbol] table_name joined table name
+    # @param  [Hash, Array] opts column names and values
+    # @return [Bogusdb::Record, Array] joined table rows 
+    def join_table(table_name, opts)
+      self.class.send(:define_method, table_name.to_sym) do 
+        self.class.create([opts].flatten)
+      end
+      self.send(table_name)
+    end
+
+    alias_method :has_many, :join_table
+
+    # @param  [String, Symbol] table_name joined table name
+    # @param  [Hash] opt column names and values
+    # @return [Bogusdb::Record] joined table 
+    def has_one(table_name, opt)
+      self.class.send(:define_method, table_name.to_sym) do 
+        self.class.new(opt)
+      end
+      self.send(table_name)
+    end
+
+    def inspect
+      nice_format = attributes.collect { |k,v|
+        "#{k}: #{v}"
+      }.compact.join(", ")
+      "#<#{self.class.name}: #{nice_format}"
+    end
+
+    private
+
+    def id
+      SecureRandom.random_number(100)
+    end
+
+
+    def column_names
+      @table_data.keys
+    end
+
+    def set_id
+      unless @table_data.include?("id" || :id)
+        @table_data.merge!(id: id)
+      end
+    end
+
+    def initialize_attributes(options)
+      options.each do |key,value|
+        if value.is_a?(Hash) || value.is_a?(Array)
+          self.define_singleton_method(key) { Record.create(value) }
+        else
+          self.define_singleton_method(key)       { options[key] }
+          self.define_singleton_method("#{key}=") { |val| options[key]=val }
+        end
+      end
+    end
+  end
+end

data/lib/bogusdb/version.rb

@@ -0,0 +1,3 @@
+module Bogusdb
+  VERSION = "0.1.2"
+end

data/test/bogusdb_test.rb

@@ -0,0 +1,11 @@
+require_relative "test_helper"
+
+class BogusdbTest < MiniTest::Test
+  def setup
+    
+  end
+
+  def test_bogusdb_responds_to_version
+    assert Bogusdb::VERSION
+  end
+end

data/test/record_test.rb

@@ -0,0 +1,108 @@
+require_relative "test_helper"
+
+class RecordTest < MiniTest::Test
+  def setup
+    @bogusdb = Bogusdb::Record.new(name: 'akira', dob: '04/14/75')
+  end
+  
+  def test_responds_to_new
+    assert_respond_to Bogusdb::Record, :new
+  end
+
+  def test_responds_to_create
+    assert_respond_to Bogusdb::Record, :create
+  end
+
+  def test_bogusdb_does_not_accept_string_params
+    assert_raises(TypeError) {
+      Bogusdb::Record.new("some_param")
+    }
+  end
+
+  def test_multiple_records_on_create
+    @bogusdb = Bogusdb::Record.create([{name: 'foo', dob: '04/14/75'},
+                                       {name: 'baz', dob: '01/01/00'} ])
+
+    assert_equal @bogusdb.first.name, 'foo' 
+  end
+
+  def test_join_table_on_create
+    @bogusdb = Bogusdb::Record.new(name: 'foo', dob: '04/14/75', profile: { avatar: 'image.jpg' })
+    assert_equal @bogusdb.profile.avatar, 'image.jpg'
+  end
+
+  def test_join_array_on_create
+    @bogusdb = Bogusdb::Record.create(name: 'foo', dob: '04/14/75', favorite_colors: [ { name: "red" }, { name: "orange" }])
+    assert_equal @bogusdb.favorite_colors.first.name, "red"
+  end
+
+  def test_bogusdb_responds_to_join_table
+    assert_respond_to @bogusdb, :join_table
+  end
+
+  def test_bogusdb_responds_to_has_one
+    assert_respond_to @bogusdb, :has_one
+  end
+
+  def test_bogusdb_responds_to_has_many
+    assert_respond_to @bogusdb, :has_many
+  end
+
+  def test_bogusdb_responds_to_name
+    assert_respond_to @bogusdb, :name
+  end
+
+  def test_bogusdb_responds_to_dob
+    assert_respond_to @bogusdb, :dob
+  end
+
+  def test_record_responds_to_attributes
+    assert_respond_to(@bogusdb, :attributes,  "Failure message.")
+  end
+
+  def test_attributes_returns_hash
+    assert_kind_of(Hash, @bogusdb.attributes)
+  end
+
+  def test_join_table_is_called_with_correct_params
+    @bogusdb.expects(:join_table).with(:profile, {avatar: 'image.jpg'})  
+    @bogusdb.join_table(:profile, {avatar: 'image.jpg'})
+  end
+
+  def test_bogusdb_responds_to_joined_tables
+    @bogusdb.join_table(:profile, {avatar: 'image.jpg'})
+    assert_respond_to @bogusdb, :profile
+  end
+
+  def test_joined_tabled_responds_to_specific_column
+    @bogusdb.join_table(:profile, {avatar: 'image.jpg'})
+    assert_respond_to @bogusdb.profile.first, :avatar
+  end
+
+  def test_joined_table_attributes_returns_hash
+    @bogusdb.join_table(:profile, [{avatar: 'image.jpg'}, {avatar: 'sunny.jpg'}])
+    assert_kind_of(Hash, @bogusdb.profile.first.attributes)
+  end
+
+  def test_has_one_record_association
+    @bogusdb.has_one(:profile, {gender: 'm', avatar: 'me.jpg'})
+    assert_kind_of Bogusdb::Record, @bogusdb.profile
+  end
+
+  def test_has_many_record_associations
+    @bogusdb.has_many(:profiles, [{avatar: 'image.jpg'}, {avatar: 'sunny.jpg'}])
+    assert_kind_of Array, @bogusdb.profiles
+  end
+
+  def test_joined_tables_when_multiples_records_are_created
+    @bogusdb = Bogusdb::Record.create([{name: 'foo', dob: '04/14/75'},
+                                       {name: 'baz', dob: '01/01/00'}
+    ])
+
+    @bogusdb.map {|i| i.join_table(:profiles, [{avatar: 'me.jpg'}, 
+                                               {avatar: 'you.png'}]) 
+    }
+    assert_equal 'me.jpg', @bogusdb.first.profiles.first.avatar
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "minitest"
+require "minitest/autorun"
+require "minitest/pride"
+require "mocha/setup"
+
+
+require File.expand_path '../../lib/bogusdb.rb', __FILE__
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: bogusdb
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Bradley Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: minitest
+  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: mocha
+  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'
+description: ' A simple fake database object for testing '
+email:
+- bradleydsmith@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bogusdb.gemspec
+- lib/bogusdb.rb
+- lib/bogusdb/record.rb
+- lib/bogusdb/version.rb
+- test/bogusdb_test.rb
+- test/record_test.rb
+- test/test_helper.rb
+homepage: https://github.com/bradleyd/bogusdb.git
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A simple fake ORM databsase object used in testing
+test_files:
+- test/bogusdb_test.rb
+- test/record_test.rb
+- test/test_helper.rb