safe_finder 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7888a25bfecaee45bf6a1ae510d17f488b195573
-  data.tar.gz: 5d3dd4b94fabf2d2b3978ae4e74348955c12e4e6
+  metadata.gz: 1e21ddcab7d21480ced641a0530ed32e6837d09d
+  data.tar.gz: 8ec78514a069609faa307801108f4b480003bd5c
 SHA512:
-  metadata.gz: c1c08c62dfee492ff309f3d029e85cb0b31541d83f18aca392c068ad7d31615c6608534efdd1795768772e0a247371e33a4792d9817a07a8bf2016c5b1e4eb7b
-  data.tar.gz: 3585c85b192eb6b42603948b5ddf5cb843934b50864c347f4b6b1e6d749b428aba8870f1b8f9bac31740de7d869e0287ca45c6d9c75790b891c651fb066fdacb
+  metadata.gz: 7349ae3e416784d2a62681b14d190dfd2e8c044edfc07ce026c69b874dee94feb5dc76ef6c21c4c983392fa0f4ef7dd41538df8e9f1c9a189acdda7747fc9cc7
+  data.tar.gz: c8af28a85c08425f4ac738c760b58371fda1e2c20b415715a8b72f5637647d1bcc6e8e0123cfab94d8e2147695745fbbb6cf9f92eb3cfe218f94f194301356df

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -3,11 +3,11 @@
 [![Test Coverage](https://codeclimate.com/github/st0012/SafeFinder/badges/coverage.svg)](https://codeclimate.com/github/st0012/SafeFinder/coverage)
 # SafeFinder
 
-SafeFinder let you define model's null_object through simple DSL, and returns it when you can't find a result.
+SafeFinder lets you define a model's `Null Object` through a simple DSL, and returns that when you don't find an instance of that model.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'safe_finder'
@@ -34,20 +34,20 @@ class Post < ActiveRecord::Base
 end
 ```
 
-Now you can query like this, but it doesn't find anything:
+Now you can query like this, and if it doesn't find anything it returns a `Null Object`:
 
 ```ruby
-# It returns a null_object
-null_object = Post.safely.find_by_title("New Post")
+# It returns a Null Object
+null_object = Post.safely.find_by_title("Not Exists")
 
 null_object.class   # NullPost
 null_object.title   # nil
 null_object.content # nil
 ```
 
-### Custom Attribute & Method
+### Custom Attributes and Methods
 
-And you can custom null_object's attribute or method using DSL:
+And you can customize the Null Object's attributes or methods using a DSL:
 
 ```ruby
 class Post < ActiveRecord::Base
@@ -60,22 +60,28 @@ class Post < ActiveRecord::Base
 end
 ```
 
-### Get NullObject directly
+```ruby
+null_object = Post.safely.find_by_title("Not Exists")
+null_object.title # "Null"
+null_object.some_method # "Do Something"
+```
+
+### Get a Null Object directly
 
 Just simply use:
 ```ruby
-Post.null_object => #<NullPost:0x007fa8a4713be0>
+Post.null_object # <NullPost:0x007fa8a4713be0>
 ```
 
 ### Inheritance
 
-All null_object inherits `SafeFinder::NullObject`, so you can add it in
+All `Null Object`s inherit `SafeFinder::NullObject`, so you can add it in
 
 ```
 app/models/safe_finder/null_object.rb
 ```
 
-to define general methods for every null_object
+to define general methods for every `Null Object`n
 
 ```ruby
 module SafeFinder
@@ -87,10 +93,15 @@ module SafeFinder
 end
 ```
 
+```ruby
+null_object = Post.null_object
+null_object.hello # "Hello"
+```
+
 
 ## TODOs
 
-- Add association support, like `user.post` should also returns null_object when it's nil
+- Add association support, like `user.post` should also returns `Null Object` when it's nil
 - Add generator for `NullObject` model
 - More use cases in readme
 

data/lib/safe_finder.rb

@@ -1,3 +1,4 @@
+require "safe_finder/generators/model_generator"
 require "safe_finder/null_object_generator"
 require "safe_finder/null_object"
 require "safe_finder/class_wrapper"

data/lib/safe_finder/class_wrapper.rb

@@ -9,7 +9,7 @@ module SafeFinder
     def method_missing(name, *arguments, &block)
       result = wrapped_class.send(name, *arguments, &block)
       result.nil? ? wrapped_class.null_object : result
-    rescue ActiveRecord::RecordNotFound => e
+    rescue ActiveRecord::RecordNotFound
       wrapped_class.null_object
     end
   end

data/lib/safe_finder/generators/model_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators"
+
+module SafeFinder
+  class ModelGenerator < Rails::Generators::Base
+    def self.source_root
+      File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+    end
+
+    def create_model
+      template "models/null_object.rb", File.join("app/models", "safe_finder", "null_object.rb")
+    end
+  end
+end

data/lib/safe_finder/generators/templates/models/null_object.rb

@@ -0,0 +1,5 @@
+module SafeFinder
+  class NullObject
+
+  end
+end

data/lib/safe_finder/null_object_generator.rb

@@ -33,8 +33,6 @@ module SafeFinder
     def get_value(column)
       if value = setted_columns[column.name.to_sym]
         value
-      else
-        nil
       end
     end
 

data/lib/safe_finder/version.rb

@@ -1,3 +1,3 @@
 module SafeFinder
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/safe_finder.gemspec

@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "generator_spec"
 
+  spec.add_dependency "rails", ">= 4.0"
   spec.add_dependency "activerecord", ">= 4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe_finder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stan Loe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +140,8 @@ files:
 - bin/setup
 - lib/safe_finder.rb
 - lib/safe_finder/class_wrapper.rb
+- lib/safe_finder/generators/model_generator.rb
+- lib/safe_finder/generators/templates/models/null_object.rb
 - lib/safe_finder/null_object.rb
 - lib/safe_finder/null_object_generator.rb
 - lib/safe_finder/version.rb