rule_table 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46a83fa6f320199978d1215ce239cbf385613b3d
+  data.tar.gz: dab18566c442b77de292320c71a36bdfd03ef988
+SHA512:
+  metadata.gz: b8a4714b815af8360c8e7e776d09366f87f703b5738c98e1e2600a5bc0ac7308bd4db6cf036b0c6e2ce198e28fb90a1247426e9696cc1e5a85434609366c9b1f
+  data.tar.gz: 91b2f8bff0fb924a063542e95d309c8749b92c706adc368ef02b3dc0aabf19f21a8fc583361a0e8dc059e9ae1d479ba4e15a8baf1ab966aa955fd17ff66ec0c5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--order random

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 iain
+
+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,126 @@
+# RuleTable
+
+Based on [RubyTapas episode 358](http://www.rubytapas.com/episodes/358-Rule-Table),
+this is a simple rule table, but with a more fancy API. In fact, I'm using all
+of Ruby's meta programming tricks to get here. That might not be your cup of tea
+and that's okay.
+
+In short, RuleTable allows you to flatten the state space of a problem.
+Instead of branching, and branching, and branching again, we can see all the
+criteria for a given target in one place.
+
+Essentially, it turns a big nested set of rules into a flat list of rules.
+
+This is a tiny gem, made in one evening.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rule_table'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rule_table
+
+## Usage
+
+To get the full context of this example, see the RubyTapas episode.
+
+First up, let's define the matchers. These allow you to do define checks that
+can be used later on. A matcher has a name and block. The name is used to
+reference it later on. The block defines how the matcher should be applied. We
+use `instance_exec` to put you inside the object you're matching against.
+
+``` ruby
+RuleTable.matcher :os do |pattern|
+  pattern === os
+end
+
+RuleTable.matcher :width do |pattern|
+  pattern === resolution.width
+end
+
+RuleTable.matcher :height do |pattern|
+  pattern === resolution.height
+end
+
+RuleTable.matcher :misc do |pattern|
+  pattern === user_agent_misc
+end
+```
+
+Next up is defining the rules. Rules are order dependent. The first rule for
+which everything matches, is the one that is returned.
+
+``` ruby
+TABLE = RuleTable.new do
+
+  rule :ios_hi, match(:os,     /ios/i),
+                match(:width,  1024..2732),
+                match(:height, 768..2048)
+
+  rule :ios_lo, match(:os,     /ios/i),
+                match(:width,  0...1024),
+                match(:height, 0...768)
+
+  rule :ereader, match(:os,    /android/i),
+                 match(:misc,  /inky/i)
+
+  # more rules omitted
+
+  rule :unknown
+
+end
+```
+
+Finally, we can find the rule:
+
+``` ruby
+device = OpenStruct.new(
+  os: "Android",
+  resolution: OpenStruct.new(
+    width: 1430,
+    height: 1080
+  ),
+  user_agent_misc: "(Inky)",
+)
+
+TABLE.match(device) # => :ereader
+```
+
+Finally, there is also a way to debug why a certain target was found. Simply
+replace the message send `match` with `match_with_trace`.
+
+```
+target, trace = TABLE.match_with_trace(device)
+target # => :ereader
+trace # =>
+# [
+#   { target: :ios_hi,  matched: [] },
+#   { target: :ios_lo,  matched: [] },
+#   { target: :ereader, matched: [:os, :misc] }
+# ]
+```
+
+## 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/iain/rule_table.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "rule_table"
+
+# 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/rule_table.rb

@@ -0,0 +1,83 @@
+require "rule_table/version"
+
+module RuleTable
+
+  def self.matcher(name, &block)
+    matchers[name] = block
+  end
+
+  def self.matchers
+    @matchers ||= {}
+  end
+
+  def self.new(&block)
+    Table.new.tap { |table| TableDefiner.new(table, &block) }
+  end
+
+  class Table
+
+    def initialize
+      @rules = []
+    end
+
+    def add_rule_for(target, *matchers)
+      @rules << [ target, matchers ]
+    end
+
+    def match(object)
+      @rules.find { |(_target, matchers)|
+        matchers.all? { |m| m.matches?(object) }
+      }.first
+    end
+
+    def match_with_trace(object)
+      trace = []
+      result = @rules.find { |(target, matchers)|
+        partial_trace = { target: target, matched: [] }
+        matchers.all? { |m|
+          m.matches?(object).tap { |match_result|
+            partial_trace[:matched] << m.matcher_name if match_result
+          }
+        }.tap {
+          trace << partial_trace
+        }
+      }.first
+      [ result, trace ]
+    end
+
+  end
+
+  class TableDefiner
+
+    def initialize(table, &block)
+      @table = table
+      instance_eval(&block)
+    end
+
+    def rule(*args)
+      @table.add_rule_for(*args)
+    end
+
+    def match(matcher_name, *args)
+      ConfiguredMatcher.new(matcher_name, *args)
+    end
+
+  end
+
+  class ConfiguredMatcher
+
+    attr_reader :matcher_name
+
+    def initialize(matcher_name, *args)
+      @matcher_name = matcher_name
+      @matcher = RuleTable.matchers.fetch(matcher_name)
+      @args    = args
+    end
+
+    def matches?(object)
+      object.instance_exec(*@args, &@matcher)
+    end
+
+  end
+
+end

data/lib/rule_table/version.rb

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

data/rule_table.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rule_table/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rule_table"
+  spec.version       = RuleTable::VERSION
+  spec.authors       = ["iain"]
+  spec.email         = ["iain@iain.nl"]
+
+  spec.summary       = %q{A simple implementation of a rule table with lots of metaprogramming.}
+  spec.homepage      = "https://github.com/iain/rule_table"
+  spec.license       = "MIT"
+
+  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", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rule_table
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: 
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rule_table.rb
+- lib/rule_table/version.rb
+- rule_table.gemspec
+homepage: https://github.com/iain/rule_table
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple implementation of a rule table with lots of metaprogramming.
+test_files: []
+has_rdoc: