safe_finder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7888a25bfecaee45bf6a1ae510d17f488b195573
+  data.tar.gz: 5d3dd4b94fabf2d2b3978ae4e74348955c12e4e6
+SHA512:
+  metadata.gz: c1c08c62dfee492ff309f3d029e85cb0b31541d83f18aca392c068ad7d31615c6608534efdd1795768772e0a247371e33a4792d9817a07a8bf2016c5b1e4eb7b
+  data.tar.gz: 3585c85b192eb6b42603948b5ddf5cb843934b50864c347f4b6b1e6d749b428aba8870f1b8f9bac31740de7d869e0287ca45c6d9c75790b891c651fb066fdacb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+
+notifications:
+  email:
+    recipients:
+      - stan001212@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in safe_finder.gemspec
+gemspec
+
+gem "pry", require: true
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -0,0 +1,106 @@
+[![Build Status](https://travis-ci.org/st0012/SafeFinder.svg)](https://travis-ci.org/st0012/SafeFinder)
+[![Code Climate](https://codeclimate.com/github/st0012/SafeFinder/badges/gpa.svg)](https://codeclimate.com/github/st0012/SafeFinder)
+[![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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safe_finder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safe_finder
+
+## Usage
+
+### Basic
+Let's say you have a `Post` class, and it has `title` and `content` column.
+
+First, you need to include `SafeFinder` in your model:
+
+```ruby
+class Post < ActiveRecord::Base
+  include SafeFinder
+end
+```
+
+Now you can query like this, but it doesn't find anything:
+
+```ruby
+# It returns a null_object
+null_object = Post.safely.find_by_title("New Post")
+
+null_object.class   # NullPost
+null_object.title   # nil
+null_object.content # nil
+```
+
+### Custom Attribute & Method
+
+And you can custom null_object's attribute or method using DSL:
+
+```ruby
+class Post < ActiveRecord::Base
+  include SafeFinder
+  
+  safe_attribute :title, "Null"
+  safe_method :some_method do
+    "Do Something"
+  end
+end
+```
+
+### Get NullObject directly
+
+Just simply use:
+```ruby
+Post.null_object => #<NullPost:0x007fa8a4713be0>
+```
+
+### Inheritance
+
+All null_object inherits `SafeFinder::NullObject`, so you can add it in
+
+```
+app/models/safe_finder/null_object.rb
+```
+
+to define general methods for every null_object
+
+```ruby
+module SafeFinder
+  class NullObject
+    def hello
+      "Hello"
+    end
+  end
+end
+```
+
+
+## TODOs
+
+- 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
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/st0012/SafeFinder.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safe_finder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/safe_finder/class_wrapper.rb

@@ -0,0 +1,16 @@
+module SafeFinder
+  class ClassWrapper
+    attr_reader :wrapped_class
+
+    def initialize(target_class)
+      @wrapped_class = target_class
+    end
+
+    def method_missing(name, *arguments, &block)
+      result = wrapped_class.send(name, *arguments, &block)
+      result.nil? ? wrapped_class.null_object : result
+    rescue ActiveRecord::RecordNotFound => e
+      wrapped_class.null_object
+    end
+  end
+end

data/lib/safe_finder/null_object.rb

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

data/lib/safe_finder/null_object_generator.rb

@@ -0,0 +1,61 @@
+module SafeFinder
+  class NullObjectGenerator
+    attr_reader :original_class, :original_class_name, :null_class, :setted_columns
+
+    def initialize(original_class)
+      @original_class = original_class
+      @original_class_name = original_class.to_s
+      @null_class = create_null_class
+      @setted_columns = original_class.null_object_attributes
+    end
+
+    def generate
+      set_attributes
+      set_methods
+      null_class.new
+    end
+
+    private
+
+    def create_null_class
+      Object.const_set("Null#{original_class_name}", Class.new(NullObject))
+    end
+
+    def get_attributes
+      original_class.columns.inject({}) do |result, column|
+        result[column.name] = get_value(column)
+        result
+      end
+    end
+
+    # I want to support default value here.
+    # But column object's default value is string, and needs some mechanism be to converted into ruby's type
+    def get_value(column)
+      if value = setted_columns[column.name.to_sym]
+        value
+      else
+        nil
+      end
+    end
+
+    def set_methods
+      methods = original_class.null_object_methods
+      null_class.class_eval do
+        methods.each do |key, value|
+          define_method key, value
+        end
+      end
+    end
+
+    def set_attributes
+      attributes = get_attributes
+      null_class.class_eval do
+        attributes.each do |key, value|
+          define_method key do
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/safe_finder/version.rb

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

data/lib/safe_finder.rb

@@ -0,0 +1,35 @@
+require "safe_finder/null_object_generator"
+require "safe_finder/null_object"
+require "safe_finder/class_wrapper"
+require "safe_finder/version"
+
+module SafeFinder
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.singleton_class.class_eval do
+      attr_accessor :null_object_attributes, :null_object_methods
+    end
+    base.class_eval do
+      self.null_object_attributes = {}
+      self.null_object_methods = {}
+    end
+  end
+
+  module ClassMethods
+    def safely
+      ClassWrapper.new(self)
+    end
+
+    def null_object
+      @null_object ||= SafeFinder::NullObjectGenerator.new(self).generate
+    end
+
+    def safe_attribute(key, value)
+      null_object_attributes[key.to_sym] = value
+    end
+
+    def safe_method(method_name, &block)
+      null_object_methods[method_name.to_sym] = block
+    end
+  end
+end

data/safe_finder.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safe_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe_finder"
+  spec.version       = SafeFinder::VERSION
+  spec.authors       = ["Stan Loe"]
+  spec.email         = ["stan001212@gmail.com"]
+
+  spec.summary       = %q{SafeFinder lets you define model's null_object through simple DSL, and returns it when you can't find a result.}
+  spec.description   = %q{SafeFinder lets you define model's null_object through simple DSL, and returns it when you can't find a result.}
+  spec.homepage      = "https://github.com/st0012/SafeFinder"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_dependency "activerecord", ">= 4.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: safe_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stan Loe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: database_cleaner
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: sqlite3
+  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: activerecord
+  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'
+description: SafeFinder lets you define model's null_object through simple DSL, and
+  returns it when you can't find a result.
+email:
+- stan001212@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safe_finder.rb
+- lib/safe_finder/class_wrapper.rb
+- lib/safe_finder/null_object.rb
+- lib/safe_finder/null_object_generator.rb
+- lib/safe_finder/version.rb
+- safe_finder.gemspec
+homepage: https://github.com/st0012/SafeFinder
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: SafeFinder lets you define model's null_object through simple DSL, and returns
+  it when you can't find a result.
+test_files: []
+has_rdoc: