polaroid 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a8763fe87a6c9ee53c561598522032c5fc8cb1e
+  data.tar.gz: 8c47aaaba2d6f15ea7e8ce2489fc5cdfea84b7ef
+SHA512:
+  metadata.gz: 136cfacbbe47466f4bcd335c94d00cef7745c3dbe505284fbd85132c7663e5ef05e027974f8c7d4ca572cd21fc8f669226cb46dc8e344711015c2298cc27023f
+  data.tar.gz: 4523e17ffa547f4cd3d56a0d17a650cd4e17012c5ca4aabdf0d726e8ce888db84784a936f68013f7513c9c4ed5b6c8d061bcf37dd480b1c2303d4e91047efc6a

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version
+.ruby-gemset

data/README.md

@@ -91,7 +91,7 @@ Of course you do. So the `take_snapshot` and `build_from_snapshot` methods also
 
 ```ruby
 pat = Person.new('Patrick', 25, ['beer', 'coffee', 'ramen', 'pie'])
-json_snapshot = snapshot.take_snapshot(pat, :json)
+json_snapshot = pat.take_snapshot(:json)
 # => "{\"name\":\"Patrick\",\"age\":25,\"favorite_drinks\":[\"beer\",\"coffee\"]}"
 Person.build_from_snapshot(json_snapshot, :json)
 # => #<struct Person::Snapshot name="Patrick", age=25, favorite_drinks=["beer", "coffee"]>

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs        << "test"
+  t.test_files  = Dir[File.join(File.dirname(__FILE__), 'test/**/*test.rb')]
+end

data/lib/polaroid.rb

@@ -1,6 +1,7 @@
-class Polaroid < Module
+require 'json'
+require 'immutable_struct'
 
-  VERSION = "0.0.4"
+class Polaroid < Module
 
   def initialize(*messages)
     @messages = messages

data/lib/polaroid/version.rb

@@ -0,0 +1,3 @@
+class Polaroid < Module
+  VERSION = "0.0.5"
+end

data/polaroid.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'polaroid'
+require 'polaroid/version'
 
 Gem::Specification.new do |spec|
   spec.name           = "polaroid"
@@ -15,12 +15,13 @@ Gem::Specification.new do |spec|
   spec.license        = "MIT"
 
   spec.files          = `git ls-files -z`.split("\x0")
-  # spec.executables    = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files     = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths  = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1"
+  spec.add_development_dependency "turn-again-reporter", "~> 1.1", ">= 1.1.0"
 
   spec.add_runtime_dependency "immutable_struct", "~> 1.1"
   spec.add_runtime_dependency "json", "~> 1.8"

data/test/polaroid_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+require 'sample_implementations/person'
+
+class PolaroidTest < Minitest::Test
+
+
+  test "simple hash snapshot" do
+    pat       = Person.new("Patrick", 25, ['beer', 'coffee', 'ramen', 'pie'])
+    expected  = { name: "Patrick", age: 25, favorite_drinks:  ['beer', 'coffee'] }
+
+    assert_equal(expected, pat.take_snapshot)
+  end
+
+
+  test "can restore from a snapshot" do
+    snapshot  = { name: "Patrick", age: 25, favorite_drinks:  ['beer', 'coffee'] }
+    pat       = Person.build_from_snapshot(snapshot)
+
+    assert_equal("Patrick", pat.name)
+    assert_equal(25, pat.age)
+    assert_equal(['beer', 'coffee'], pat.favorite_drinks)
+  end
+
+
+  test "objects restored from snapshot do not respond to messages not captured" do
+    snapshot  = { name: "Patrick", age: 25, favorite_drinks:  ['beer', 'coffee'] }
+    pat       = Person.build_from_snapshot(snapshot)
+    will_respond_to = [:name, :age, :favorite_drinks]
+    wont_respond_to = [:favorite_foods, :drink?, :food?, :favorites]
+
+    will_respond_to.each do |msg|
+      assert(pat.respond_to?(msg))
+    end
+    wont_respond_to.each do |msg|
+      refute(pat.respond_to?(msg))
+    end
+  end
+
+  ##
+  # Testing the string-equality of direct JSON output is not the optimal manner of
+  # testing the output of this, as it would bind this check to the specific output
+  # format of a particular JSON library's internal choices on formatting, whereas
+  # JSON is flexible to some amount of whitespace.
+  test "json snapshot parses back to the correct value" do
+    pat       = Person.new("Patrick", 25, ['beer', 'coffee', 'ramen', 'pie'])
+    snapshot  = pat.take_snapshot(:json)
+    # JSON will come back with string keys, not symbols
+    expected  = { 'name' => "Patrick", 'age' => 25, 'favorite_drinks' =>  ['beer', 'coffee'] }
+    parsed    = JSON.parse(snapshot)
+
+    assert_equal(expected, parsed)
+  end
+
+
+  test "objects can be restored from a json snapshot" do
+    snapshot  = "{\"name\":\"Patrick\",\"age\":25,\"favorite_drinks\":[\"beer\",\"coffee\"]}"
+    pat       = Person.build_from_snapshot(snapshot, :json)
+
+    assert_equal("Patrick", pat.name)
+    assert_equal(25, pat.age)
+    assert_equal(['beer', 'coffee'], pat.favorite_drinks)
+  end
+
+end

data/test/sample_implementations/person.rb

@@ -0,0 +1,27 @@
+class Person
+  include Polaroid.new(:name, :age, :favorite_drinks)
+
+  attr_reader :name, :age, :favorites
+
+  def initialize(name, age, favorites)
+    @name       = name
+    @age        = age
+    @favorites  = favorites
+  end
+
+  def favorite_drinks
+    favorites.select { |fav| drink?(fav) }
+  end
+
+  def favorite_foods
+    favorites.select { |fav| food?(fav) }
+  end
+
+  def drink?(str)
+    %w[coffee beer wine tea water juice].include?(str)
+  end
+
+  def food?(str)
+    %w[omelete burrito ramen pie yogurt].include?(str)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/reporters/turn_again_reporter'
+
+Minitest::Reporters.use!(Minitest::Reporters::TurnAgainReporter.new)
+
+require 'polaroid'
+
+##
+# Blatantly stolen from ActiveSupport::Testing::Declarative
+# Allows for test files such as
+#   test "verify something" do
+#     ...
+#   end
+# which become methods named test_verify_something, leaving a visual difference
+# between tests themselves and any helper methods declared in the usual
+# manner of `def some_helper_method`.
+module DeclarativeTests
+  def test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+    defined = instance_method(test_name) rescue false
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        flunk "No implementation provided for #{name}"
+      end
+    end
+  end
+end
+
+class Minitest::Test
+  extend DeclarativeTests
+end

metadata

@@ -1,78 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: polaroid
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Paul Kwiatkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2016-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: turn-again-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: immutable_struct
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 description: Polaroid provides shortcuts to capture the state of a Ruby object, and
@@ -85,37 +110,43 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/polaroid.rb
+- lib/polaroid/version.rb
 - polaroid.gemspec
+- test/polaroid_test.rb
+- test/sample_implementations/person.rb
+- test/test_helper.rb
 homepage: https://github.com/swifthand/polaroid
 licenses:
 - MIT
+metadata: {}
 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.25
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Polaroid provides shortcuts to capture the state of a Ruby object, and can
   construct a fake object later to mimic that state.
-test_files: []
+test_files:
+- test/polaroid_test.rb
+- test/sample_implementations/person.rb
+- test/test_helper.rb