simplifier 0.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle
+/.ruby-version
+/Gemfile.lock
+/*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John Barnette
+
+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,48 @@
+# Simplifier
+
+A Ruby library for simplifying object graphs.
+
+```ruby
+require "simplifier"
+
+Simplifier.new.simplify({ :foo => [:bar, "baz", Time.now] })
+# => {"foo"=>["bar", "baz", "2013-06-11T00:03:27Z"]}
+```
+
+## By default
+
+- `nil`, `true`, and `false` are themselves.
+- Symbols are simplified into interned, frozen Strings.
+- Strings are UTF-8 with `\n` newlines.
+- Strings in the `BINARY` encoding are themselves.
+- Arrays and Sets are simplified into Arrays of simplified elements.
+- Hashes are simplified into Hashes of simplified keys and values.
+- Dates become an ISO 8601 `"yyyy-mm-dd"` String.
+- DateTimes and Times become an ISO 8601 `"yyyy-mm-ddThh:mm:ssZ"` String.
+- Any other types raise `Simplifier::Unknown`.
+
+## Extending
+
+```ruby
+require "simplifier"
+
+class APISimplifier < Simplifier
+  def simplify(object)
+    case object
+    when MyApp::User
+      simplify :id => object.id, :name => object.name
+
+    else
+      super
+    end
+  end
+end
+```
+
+The constructor for `Simplifier` takes an optional configuration Hash and
+assigns it to the `options` attribute. This can be useful if you need to
+change the simplification of a type depending on embedding or other factors.
+
+## Maintainer
+
+[@jbarnette](https://github.com/jbarnette)

data/lib/simplifier.rb

@@ -0,0 +1,77 @@
+require "set"
+require "time"
+
+# Public: Reduce Ruby objects to a more primitive representation.
+class Simplifier
+
+  # Public: Raised when an object is simplified twice in one call.
+  class Circular < RuntimeError
+    def initialize(object)
+      super "Circular reference to #{object.class.name} #{object.inspect}"
+    end
+  end
+
+  # Public: Raised when an object can't be simplified.
+  class Unknown < RuntimeError
+    def initialize(object)
+      super "Can't simplify #{object.class.name} #{object.inspect}"
+    end
+  end
+
+  # Public: Get a Hash of Symbol-keyed options.
+  attr_reader :options
+
+  # Internal: A Hash cache of String representations of Symbols.
+  attr_reader :symbols
+
+  # Public: Create a new instance.
+  def initialize(options = nil)
+    @options = options || {}
+    @symbols = Hash.new { |h, k| h[k] = k.to_s.freeze }
+  end
+
+  # Internal.
+  def simplify(object)
+    case object
+    when Array, Set
+      object.map { |o| simplify o }
+
+    when DateTime
+      simplify object.to_time
+
+    when Date
+      object.iso8601
+
+    when Hash
+      {}.tap do |hash|
+        object.each do |key, value|
+          hash[simplify key] = simplify value
+        end
+      end
+
+    when NilClass
+      object
+
+    when Numeric
+      object
+
+    when String
+      return object if object.encoding == Encoding::BINARY
+
+      object.encode Encoding::UTF_8,
+        :invalid => :replace, :undef => :replace, :universal_newline => true
+
+    when Symbol
+      symbols[object]
+
+    when Time
+      object.utc.iso8601
+
+    when TrueClass, FalseClass
+      object
+
+    else
+      raise Unknown, object
+    end
+  end
+end

data/script/bootstrap

@@ -0,0 +1,9 @@
+#!/bin/sh
+# Ensure local dependencies are available.
+
+set -e
+
+cd $(dirname "$0")/..
+rm -rf .bundle/{binstubs,config}
+
+bundle install --binstubs .bundle/binstubs --path .bundle --quiet "$@"

data/script/release

@@ -0,0 +1,39 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Build a new gem archive.
+
+rm -rf simplifier-*.gem
+gem build -q simplifier.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls simplifier-*.gem | sed 's/^simplifier-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push simplifier-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag" &&
+    rm simplifier-*.gem

data/script/test

@@ -0,0 +1,11 @@
+#!/bin/sh
+# Run the unit tests.
+
+set -e
+
+cd $(dirname "$0")/..
+  script/bootstrap && ruby -I lib -r rubygems \
+    -e 'require "bundler/setup"' \
+    -e 'require "minitest/autorun"' \
+    -e '(ARGV.empty? ? Dir["test/**/*_test.rb"] : ARGV).each { |f| load f }' \
+    -- "$@"

data/simplifier.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |gem|
+  gem.name          = "simplifier"
+  gem.version       = "0.0.0"
+  gem.authors       = ["John Barnette"]
+  gem.email         = ["john@jbarnette.com"]
+  gem.description   = "Reduce objects to a simpler representation."
+  gem.summary       = "Reduce object graphs."
+  gem.homepage      = "https://github.com/jbarnette/simplifier"
+
+  gem.files         = `git ls-files`.split $/
+  gem.executables   = []
+  gem.test_files    = gem.files.grep /^test/
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "minitest"
+end

data/test/simplifier_test.rb

@@ -0,0 +1,89 @@
+require "simplifier"
+
+describe Simplifier do
+  before do
+    @simplifier = Simplifier.new
+  end
+
+  it "can take initializer options" do
+    s = Simplifier.new :foo => :bar
+    assert_equal :bar, s.options[:foo]
+  end
+
+  it "raises when an object can't be simplified" do
+    assert_raises Simplifier::Unknown do
+      @simplifier.simplify Object.new
+    end
+  end
+
+  it "simplifies nil to nil" do
+    assert_nil @simplifier.simplify nil
+  end
+
+  it "simplifies false to false" do
+    assert_same false, @simplifier.simplify(false)
+  end
+
+  it "simplifies true to true" do
+    assert_same true, @simplifier.simplify(true)
+  end
+
+  it "simplifies Numerics to themselves" do
+    assert_equal 42, @simplifier.simplify(42)
+    assert_equal 4.2, @simplifier.simplify(4.2)
+  end
+
+  it "simplifies Symbols to Strings" do
+    assert_equal "sym", @simplifier.simplify(:sym)
+    assert_same @simplifier.simplify(:sym), @simplifier.simplify(:sym)
+    assert @simplifier.simplify(:sym).frozen?
+  end
+
+  it "simplifies Strings to UTF-8" do
+    assert_equal "foo", @simplifier.simplify("foo")
+    refute_same "foo", @simplifier.simplify("foo")
+  end
+
+  it "normalizes line endings in Strings" do
+    assert_equal "foo\n", @simplifier.simplify("foo\r\n")
+    assert_equal "foo\n", @simplifier.simplify("foo\r")
+  end
+
+  it "doesn't mess with binary encoded Strings" do
+    blob = "foo".encode Encoding::BINARY
+    assert_same blob, @simplifier.simplify(blob)
+  end
+
+  it "simplifies Arrays to Arrays of simplified objects" do
+    source   = [:foo, [:bar, :baz], :quux]
+    expected = ["foo", ["bar", "baz"], "quux"]
+
+    assert_equal expected, @simplifier.simplify(source)
+  end
+
+  it "simplifies Sets to Arrays of simplified objects" do
+    set = Set.new [:foo, :bar, :baz]
+    assert_equal %w(foo bar baz), @simplifier.simplify(set)
+  end
+
+  it "simplifies Hashes by simplifying keys and values" do
+    source   = { :foo => { :bar => [:baz, :quux] } }
+    expected = { "foo" => { "bar" => ["baz", "quux"] } }
+
+    assert_equal expected, @simplifier.simplify(source)
+  end
+
+  it "simplifies Dates to ISO 8601 Strings" do
+    assert_equal "1999-03-03", @simplifier.simplify(Date.parse("1999-03-03"))
+  end
+
+  it "simplifies Times to UTC ISO 8601 Strings" do
+    now = Time.parse "1999-03-03 23:54:16 UTC"
+    assert_equal "1999-03-03T23:54:16Z", @simplifier.simplify(now)
+  end
+
+  it "simplifiest DateTimes to UTC ISO 8601 Strings" do
+    now = DateTime.parse "1999-03-03 23:54:16 UTC"
+    assert_equal "1999-03-03T23:54:16Z", @simplifier.simplify(now)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: simplifier
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- John Barnette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Reduce objects to a simpler representation.
+email:
+- john@jbarnette.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/simplifier.rb
+- script/bootstrap
+- script/release
+- script/test
+- simplifier.gemspec
+- test/simplifier_test.rb
+homepage: https://github.com/jbarnette/simplifier
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Reduce object graphs.
+test_files:
+- test/simplifier_test.rb