minimapper 0.0.1 → 0.0.2

data/README.md

@@ -13,7 +13,7 @@ Minimapper is a partial [repository-pattern](http://martinfowler.com/eaaCatalog/
 This library only implements the most basic persistance API (mostly just CRUD). Any significant additions will be made into separate gems (with names like "minimapper-FOO").
 
 The reasons for this are:
-* You should be able to feel secure about depending on the API
+* You should be able to depend on the API
 * It should be possible to learn all it does in a short time
 * It should be simple to add an adapter for a new database
 * It should be simple to maintain minimapper
@@ -43,28 +43,37 @@ Please avoid installing directly from the github repository. Code will be pushed
 You can use the mappers directly like this:
 
 ``` ruby
+require "rubygems"
+require "minimapper"
+require "minimapper/entity"
+require "minimapper/memory"
+
 class User < Minimapper::Entity
   attributes :name, :email
-  validates :name, presence: true
+  validates :name, :presence => true
 end
 
 class UserMapper < Minimapper::Memory
 end
 
 # Creating
-user = User.new(name: "Joe")
+user = User.new(:name => "Joe")
 mapper = UserMapper.new
 mapper.create(user)
 
 # Finding
-user = mapper.find(1)
+user = mapper.find(user.id)
+puts user.name         # -> Joe
+puts mapper.first.name # -> Joe
 
 # Updating
 user.name = "Joey"
 mapper.update(user)
+puts mapper.first.name # -> Joey
 
 # Deleting
 mapper.delete(user)
+mapper.find(user)      # raises Minimapper::Common::CanNotFindEntity
 
 # Deleting all
 mapper.delete_all
@@ -73,9 +82,11 @@ mapper.delete_all
 Or though a repository:
 
 ``` ruby
+require "minimapper/repository"
+
 repository = Minimapper::Repository.build({
-  users:    UserMapper.new,
-  projects: ProjectMapper.new
+  :users    => UserMapper.new,
+  :projects => ProjectMapper.new
 })
 
 repository.users.find(1)
@@ -84,6 +95,8 @@ repository.users.find(1)
 ## Using the ActiveRecord mapper
 
 ``` ruby
+require "minimapper/ar"
+
 module AR
   class UserMapper < Minimapper::AR
   end
@@ -115,6 +128,10 @@ Robert "Uncle Bob" Martin:
 * [Architecture: The Lost Years](http://www.confreaks.com/videos/759-rubymidwest2011-keynote-architecture-the-lost-years)
 * [The Clean Architecture](http://blog.8thlight.com/uncle-bob/2012/08/13/the-clean-architecture.html)
 
+## Apps using minimapper
+
+* The deploy status app that minimapper was extracted from: [https://github.com/joakimk/deployer](https://github.com/joakimk/deployer)
+
 ## Running the tests
 
 You need mysql and postgres installed (but they do not have to be running) to be able to run bundle. The sql-mapper tests use sqlite3 by default.
@@ -131,3 +148,27 @@ You need mysql and postgres installed (but they do not have to be running) to be
 4. Don't forget to write test
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
+
+## Credits and license
+
+By [Joakim Kolsjö](https://twitter.com/joakimk) under the MIT license:
+
+>  Copyright (c) 2012 Joakim Kolsjö
+>
+>  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/lib/minimapper/memory.rb

@@ -1,3 +1,5 @@
+require 'minimapper/common'
+
 module Minimapper
   class Memory
     def initialize

data/lib/minimapper/version.rb

@@ -1,3 +1,3 @@
 module Minimapper
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/minimapper.rb

@@ -1,7 +1,4 @@
 require "minimapper/version"
-#require "minimapper/repository"
-#require "minimapper/memory"
-#require "minimapper/ar"
 
 module Minimapper
 end

data/unit/memory_spec.rb

@@ -1,5 +1,4 @@
 require 'minimapper/memory'
-require 'minimapper/common'
 require 'minimapper/entity'
 
 class TestEntity < Minimapper::Entity

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: minimapper
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Joakim Kolsj\xC3\xB6"
@@ -61,7 +61,6 @@ files:
 - .rvmrc
 - .travis.yml
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/minimapper.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2012 Joakim Kolsjö
-
-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.