ensurance 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73ed04613ebf3946434e575c85ca906f25d39626
+  data.tar.gz: 77c943a28db5eaf457eab1d3f38baaa345f0afc4
+SHA512:
+  metadata.gz: 821667d18e5db34c6cd5219bca2749eddc0fbd3f706350c1dce1b8143048424fbdac3790d8de1c269ce5a84340e1deccf26b6885d180e7324c2a5875b6d8ce50
+  data.tar.gz: 8547c089119cee156698b63e6dee1cd89d4a89f16ceabd1e60391342754bacac53656469cf98ff0a3b6ec8b7e289bab7297084511c449dcdaaf4179784910cb3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ensurance.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    ensurance (0.1.0)
+      activesupport (>= 3, < 6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.10.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3)
+  bundler (~> 1.16)
+  ensurance!
+  globalid (>= 0.3.6)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3 (>= 1.3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ben Sharpe
+
+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,100 @@
+# Ensurance
+
+Allows you to ensure you have the class you expect... it's similar to
+
+```
+result = value.is_a?(Person) ? value : Person.find(value)
+```
+
+You can add fields to "ensure_by" (:id is included always)
+e.g.
+
+ if you add `ensure_by :token` to the User class
+  User.ensure(<UserObject>) works
+  User.ensure(:user_id) works
+  User.ensure(:token) works
+
+ .ensure() returns nil if the record is not found
+ .ensure!() throws an exception if the record is not found
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ensurance'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In your Rails app... `include Ensurance` either in specific models or `ApplicationRecord` to cover all your models.
+
+It's really handy for service objects or Jobs that you want to call from the console to try out.
+
+```
+class User < ApplicationRecord
+  include Ensurance
+end
+
+
+class SomeServiceClass
+  def perform(user)
+    user = User.ensure(user)
+    # do something constructive here
+  end
+end
+```
+
+In this way you can call it with a User object, or a user `id` and it works just the same.
+
+Also adds ensurance features to `Hash`, `Time`, and `Date`
+
+```
+Time.ensure(Date.today) -> Date.today.beginning_of_day
+Time.ensure(1509556285) -> 2017-11-01 11:11:25 -0600
+Time.ensure("1509556285") -> 2017-11-01 11:11:25 -0600
+Time.ensure(DateTime.now) -> DateTime.now.to_time
+Time.ensure(nil) -> nil
+Time.ensure(1..4) -> ArgumentError "Unhandled Type for Time to ensure: Range"
+
+Date.ensure(Date.today) -> Date.today
+Date.ensure(nil) -> nil
+Date.ensure(1509556285) -> 2017-11-01
+
+Hash.ensure(<aHash>) -> <aHash>
+Hash.ensure(<json_string>) -> Hash
+Hash.ensure(nil) -> nil
+Hash.ensure(<an array>) -> <an array>.to_h
+```
+
+### ActiveRecord
+
+You can specify another field or fields to ensure by doing the following:
+
+```
+class User < ApplicationRecord
+  include Ensurance
+
+  ensure_by :token    <- totally optional
+end
+
+User.ensure(1) == User.find(1)
+User.ensure(<a user record>) -> <a user record>
+User.ensure(<globalid>) == GlobalID::Locator.locate(<globalid>)
+User.ensure(<globalid string>) == GlobalID::Locator.locate(<globalid string>)
+User.ensure(<some token>) == User.where(token: <some token>).first
+User.ensure(nil) -> nil
+User.ensuer!(nil) -> ActiveRecord::RecordNotFound
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bsharpe/ensurance.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "ensurance"
+
+# 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(__FILE__)

data/bin/setup

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

data/ensurance.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ensurance/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ensurance"
+  spec.version       = Ensurance::VERSION
+  spec.authors       = ["Ben Sharpe"]
+  spec.email         = ["bsharpe@gmail.com"]
+
+  spec.summary       = %q{Add ability to ensure common types and AR models}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport', '>= 3', '< 6'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activerecord", '>= 3', '< 6'
+  spec.add_development_dependency "globalid", '>= 0.3.6', '< 2'
+  spec.add_development_dependency "sqlite3", '>= 1.3.0', '< 4'
+end
+

data/lib/ensurance.rb

@@ -0,0 +1,52 @@
+require "ensurance/version"
+require 'active_support'
+require 'active_support/core_ext/date'
+require 'active_support/core_ext/time'
+require 'active_support/core_ext/hash'
+require 'json'
+
+require 'ensurance/date'
+require 'ensurance/time'
+require 'ensurance/hash'
+
+module Ensurance
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def ensure_by(*args)
+      @_ensure_by ||= [:id]
+      @_ensure_by += [args].flatten
+    end
+
+    def ensure(thing = nil)
+      return nil unless thing.present?
+
+      if thing.is_a?(self)
+        return thing
+      elsif thing.is_a?(GlobalID)
+        return GlobalID::Locator.locate(thing)
+      elsif thing.is_a?(Hash) && thing['_aj_globalid'] && (found = GlobalID::Locator.locate(thing['_aj_globalid']))
+        return found
+      elsif thing.is_a?(String) && found = GlobalID::Locator.locate(thing)
+        return found
+      end
+      found = nil
+
+      @_ensure_by ||= [:id]
+      @_ensure_by.each do |ensure_field|
+        value = thing.try(:fetch, ensure_field.to_sym, nil) || thing.try(:fetch, ensure_field.to_s, nil) || thing
+        found = self.find_by(ensure_field => value)
+        break if found.is_a?(self)
+      end
+
+      found
+    end
+
+    def ensure!(thing = nil)
+      result = self.ensure(thing)
+      raise ::ActiveRecord::RecordNotFound unless result
+      result
+    end
+
+  end
+end

data/lib/ensurance/date.rb

@@ -0,0 +1,42 @@
+
+module Ensurance
+  class Date
+    FORMATS = %w|%m/%d/%Y %Y/%m/%d|.freeze
+    def self.ensure(thing)
+      case thing.class.name
+      when "NilClass"
+        nil
+      when "Integer","Float"
+        Time.ensure(thing).to_date
+      when "Date"
+        thing
+      when "String"
+        if thing.to_i.to_s == thing
+          ::Time.at(thing.to_i).to_date
+        elsif thing.to_f.to_s == thing
+          ::Time.at(thing.to_f).to_date
+        elsif thing.index("/")
+          # Assume US Date format
+          result = nil
+          FORMATS.each do |f|
+            begin
+              result = Date.strptime(thing, f)
+              break
+            rescue ArgumentError
+            end
+          end
+          raise ArgumentError.new("Bad Date: #{thing}".yellow) unless result
+          result
+        else
+          ::Date.parse(thing)
+        end
+      else
+        if thing.respond_to?(:to_date)
+          thing.to_date
+        else
+          raise ArgumentError.new("Unknown Type for Date to ensure: #{thing.class.name}")
+        end
+      end
+    end
+  end
+end

data/lib/ensurance/hash.rb

@@ -0,0 +1,24 @@
+module Ensurance
+  class Hash
+    def self.ensure(thing)
+      case thing.class.name
+      when "Hash","HashWithIndifferentAccess"
+        thing
+      when "String"
+        JSON.parse(thing)
+      when "NilClass"
+        nil
+      else
+        if thing.respond_to?(:to_h)
+          begin
+            thing.to_h
+          rescue TypeError
+            raise ArgumentError.new("Unhandled Type for Hash to ensure: #{thing.class}")
+          end
+        else
+          raise ArgumentError.new("Unhandled Type for Hash to ensure: #{thing.class}")
+        end
+      end
+    end
+  end
+end

data/lib/ensurance/time.rb

@@ -0,0 +1,30 @@
+module Ensurance
+  class Time
+    def self.ensure(thing)
+      case thing.class.name
+      when "NilClass"
+        thing
+      when "Time"
+        thing
+      when "Date"
+        thing.beginning_of_day
+      when "Integer", "Float"
+        ::Time.at(thing)
+      when "String"
+        if thing.to_i.to_s == thing
+          ::Time.at(thing.to_i)
+        elsif thing.to_f.to_s == thing
+          ::Time.at(thing.to_f)
+        else
+          ::Time.parse(thing)
+        end
+      else
+        if thing.respond_to?(:to_time)
+          thing.to_time
+        else
+          raise ArgumentError.new("Unhandled Type for Time to ensure: #{thing.class}")
+        end
+      end
+    end
+  end
+end

data/lib/ensurance/version.rb

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

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: ensurance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Sharpe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: ''
+email:
+- bsharpe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ensurance.gemspec
+- file:memdb1?mode=memory&cache=shared
+- lib/ensurance.rb
+- lib/ensurance/date.rb
+- lib/ensurance/hash.rb
+- lib/ensurance/time.rb
+- lib/ensurance/version.rb
+homepage: ''
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Add ability to ensure common types and AR models
+test_files: []