checkable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7aba1e017411c601bb90fe25a0d64a05078b8865
+  data.tar.gz: 532a27db89f7a0b494b21ce966f1570db816a36a
+SHA512:
+  metadata.gz: d34ba6331a323c088cfb6b186cbdf6ace97c8bddafad30cc24f8945b0e0ced4852cb05e68b10443b8845d91ff046f3908a53ce39210e7e6a5785609b81c8522d
+  data.tar.gz: 4a54d95cb69b846aa1c5bfda1323bf1be7fbf13a5a07419521a6c60e26fedf8d2134885365062c3f89700ac0534c16b43c83f53cf16bee9d817d9825f3658e56

data/.gitignore

@@ -0,0 +1,18 @@
+*.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/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in checkable.gemspec
+gemspec

data/MIT-LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 conanite
+
+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,36 @@
+# Checkable
+
+A simple runner for checks, kind of like unit tests for user data, for cases
+where Rails validations won't cut the mustard. Runs a set of "checks" against
+your objects and lets you know what passes and what fails. Use the report as
+a basis for proposing fixes to your users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'checkable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install checkable
+
+## Usage
+
+A "check" is an object that responds to #check with one argument, the object to check.
+This method returns true if the check passes, and false if the check fails. Register your
+check by calling Checkable.register(target_type_name, check_instance)
+
+See specs for some more details.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/checkable/fork )
+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 @@
+require "bundler/gem_tasks"

data/checkable.gemspec

@@ -0,0 +1,25 @@
+# -*- coding: utf-8; mode: ruby  -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'checkable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "checkable"
+  gem.version       = Checkable::VERSION
+  gem.authors       = ["Conan Dalton"]
+  gem.license       = "MIT"
+  gem.email         = ["conan@conandalton.net"]
+  gem.summary       = %q{A simple runner for checks, kind of like unit tests for user data, for cases where Rails validations won't cut the mustard. }
+  gem.description   = %q{Runs a set of "checks" against your objects and lets you know what passes and what fails. Use the report as a basis for proposing fixes to your users. }
+  gem.homepage      = "https://github.com/conanite/checkable"
+
+  gem.add_development_dependency 'rspec', '~> 2.9'
+  gem.add_development_dependency 'rspec_numbering_formatter'
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/checkable.rb

@@ -0,0 +1,65 @@
+require "checkable/version"
+
+module Checkable
+  @@checks = Hash.new { |h,k| h[k] = [] }
+
+  def self.register type, check
+    @@checks[type] << check
+  end
+
+  def self.checks_for type
+    @@checks[type]
+  end
+
+  class FocusOnCheckClass
+    def initialize check_class
+      @check_class = check_class
+    end
+
+    def enabled? check
+      check.class == @check_class
+    end
+  end
+
+  class NoFocus
+    def self.enabled? _
+      true
+    end
+  end
+
+  class Report
+    attr_accessor :object, :passing, :failing
+
+    def initialize object
+      @object = object
+      @passing = []
+      @failing = []
+    end
+
+    def run check
+      (check.check(object) ? passing : failing) << check
+    end
+
+    def ok?
+      (passing.size > 0) && (failing.size == 0)
+    end
+  end
+
+  class Checker
+    attr_accessor :reports, :focus
+
+    def initialize focus=NoFocus
+      @focus = focus
+      @reports = []
+    end
+
+    def check object
+      report = Report.new object
+      checks = Checkable.checks_for object.class.name
+      checks.each { |check|
+        report.run check if @focus.enabled?(check)
+      }
+      @reports << report
+    end
+  end
+end

data/lib/checkable/version.rb

@@ -0,0 +1,3 @@
+module Checkable
+  VERSION = "0.0.1"
+end

data/spec/checkable_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Checkable do
+  let(:checker) { Checkable::Checker.new filter }
+
+  def run_checks thing
+    checker.check thing
+    checker.reports.first
+  end
+
+  describe "using a filter to restrict the set of checks applied" do
+    let(:filter) { Checkable::FocusOnCheckClass.new CheckWidgetIsFixed }
+
+    it "should be ok if the widget is fixed" do
+      expect(run_checks Widget.new(Battery.new, true)).to be_ok
+    end
+
+    it "should not be ok if the widget is not fixed" do
+      expect(run_checks Widget.new(Battery.new, false)).not_to be_ok
+    end
+  end
+
+  describe Widget do
+    let(:filter) { Checkable::NoFocus }
+
+    it "should not be ok if the widget is not fixed and has no battery" do
+      report = run_checks Widget.new(nil, false)
+      expect(report).not_to be_ok
+      expect(report.passing.size).to eq 0
+      expect(report.failing.size).to eq 2
+    end
+
+    it "should not be ok if the widget is is fixed but has no battery" do
+      report = run_checks Widget.new(nil, true)
+      expect(report.passing.size).to eq 1
+      expect(report.failing.size).to eq 1
+      expect(report).not_to be_ok
+    end
+
+    it "should not be ok if the widget is not fixed" do
+      report = run_checks Widget.new(Battery.new, false)
+      expect(report).not_to be_ok
+      expect(report.passing.size).to eq 1
+      expect(report.failing.size).to eq 1
+    end
+
+    it "should be ok if the widget is fixed and has a battery" do
+      report = run_checks Widget.new(Battery.new, true)
+      expect(report).to be_ok
+      expect(report.passing.size).to eq 2
+      expect(report.failing.size).to eq 0
+    end
+  end
+
+  describe Battery do
+    let(:filter) { Checkable::NoFocus }
+
+    it "should be ok if the widget is fixed" do
+      expect(run_checks Battery.new(true)).to be_ok
+    end
+
+    it "should not be ok if the widget is not fixed" do
+      expect(run_checks Battery.new).not_to be_ok
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require 'checkable'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+class Widget
+  attr_accessor :battery, :fixed
+  def initialize battery, fixed
+    @battery, @fixed = battery, fixed
+  end
+end
+
+class Battery
+  attr_accessor :charged
+  def initialize charged=false
+    @charged = charged
+  end
+end
+
+class CheckWidgetIsFixed
+  def check widget
+    widget.fixed
+  end
+end
+
+class CheckWidgetHasBattery
+  def check widget
+    widget.battery != nil
+  end
+end
+
+class CheckBatteryIsCharged
+  def check battery
+    battery.charged
+  end
+end
+
+Checkable.register "Widget",  CheckWidgetIsFixed.new
+Checkable.register "Widget",  CheckWidgetHasBattery.new
+Checkable.register "Battery", CheckBatteryIsCharged.new

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: checkable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Conan Dalton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rspec_numbering_formatter
+  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: 'Runs a set of "checks" against your objects and lets you know what passes
+  and what fails. Use the report as a basis for proposing fixes to your users. '
+email:
+- conan@conandalton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- checkable.gemspec
+- lib/checkable.rb
+- lib/checkable/version.rb
+- spec/checkable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/conanite/checkable
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple runner for checks, kind of like unit tests for user data, for cases
+  where Rails validations won't cut the mustard.
+test_files:
+- spec/checkable_spec.rb
+- spec/spec_helper.rb