cistern 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 486d6ae38fe4fb055f282a50835760d082fbebd9
-  data.tar.gz: aa7beb5d10b38bfcfa328ea86d5c7aaff78c080b
+  metadata.gz: 62a24a469ced62056ea61f768a991144ea7dad32
+  data.tar.gz: 30ca44a90ed296c9018078bf7e7ea4ee47e0925f
 SHA512:
-  metadata.gz: f3f29767bf7851718531c0611a6b32b2fca7e0d841f40e13088fe5531a9cf70473049c9da3e3bf782b751b1a6b2717e376d8ad960c807c7794cf98190dc84b1a
-  data.tar.gz: 00b3db9eb18a8e047230bd776bb539630055a7811184d0bd77479ddd4a26680a4580dd6f06e7ae09a5b5a2c639d67aa1916673bd7ac4a4df875ca04886bb9140
+  metadata.gz: e6099df1553e5ffe2545dacf6b5b0ed30962aa8a34fa5411c657e6346cf38a129d8905d2d49e8b1eb64ef105acaccdb04013acd5791e9e4e8899305a7864a333
+  data.tar.gz: ea06d0083d50711092a437b8a3af93de9ee947138c273670a45553690d2c4944214a5d2e93e778fefaead17744f9688f41333cf8de0cc1318453c23df35dec43

data/README.md

@@ -11,9 +11,9 @@ Cistern helps you consistently build your API clients and faciliates building mo
 
 ### Service
 
-This represents the remote service that you are wrapping. If the service name is 'foo' then a good name is 'Foo::Client'.
+This represents the remote service that you are wrapping. If the service name is `foo` then a good name is `Foo::Client`.
 
-Service initialization parameters are enumerated by `requires` and `recognizes`.  `recognizes` parameters are optional.
+Service initialization parameters are enumerated by `requires` and `recognizes`. Parameters defined using `recognizes` are optional.
 
 ```ruby
 class Foo::Client < Cistern::Service
@@ -34,7 +34,7 @@ Cistern will define for you two classes, `Mock` and `Real`.
 
 ### Mocking
 
-Cistern strongly encourages you to generate mock support for service. Mocking can be enabled using `mock!`.
+Cistern strongly encourages you to generate mock support for your service. Mocking can be enabled using `mock!`.
 
 ```ruby
 Foo::Client.mocking?          # falsey
@@ -70,7 +70,7 @@ end
 Foo::Client.new.get_bar # "i'm real"
 ```
 
-The `#service_method` function allows you to specific the name of generated method.
+The `#service_method` function allows you to specify the name of the generated method.
 
 ```ruby
 class Foo::Client::GetBars < Foo::Client::Request
@@ -224,8 +224,7 @@ client.data["bars"] += ["y"] # ["y"]
 client.data.object_id        # 70199868378300
 client.clear
 client.data["bars"]          # []
-
-client.data.object_id        # 70199868566840
+client.data.object_id        # 70199868378300
 ```
 
 * `store` and `[]=` write

data/lib/cistern/formatter.rb

@@ -7,6 +7,10 @@ module Cistern::Formatter
       Cistern::Formatter::AwesomePrint
     elsif defined?(::Formatador)
       Cistern::Formatter::Formatador
+    else
+      Cistern::Formatter::Default
     end
   end
 end
+
+require 'cistern/formatter/default'

data/lib/cistern/formatter/default.rb

@@ -0,0 +1,22 @@
+module Cistern::Formatter::Default
+  class << self
+    def call(object)
+      case object
+      when Cistern::Collection
+        format_collection(object)
+      when Cistern::Model
+        format_model(object)
+      else
+        object.to_s
+      end
+    end
+
+    def format_model(model)
+      "#{model.to_s} #{model.attributes.inspect}"
+    end
+
+    def format_collection(collection)
+      "#{collection.to_s} #{collection.attributes.inspect} records=[#{collection.records.map { |m| format_model(m) }.join(", ")}]"
+    end
+  end
+end

data/lib/cistern/model.rb

@@ -24,11 +24,7 @@ module Cistern::Model
   attr_accessor :collection, :service
 
   def inspect
-    if Cistern.formatter
-      Cistern.formatter.call(self)
-    else
-      "#<#{self.class} #{self.identity}"
-    end
+    Cistern.formatter.call(self)
   end
 
   def initialize(attributes={})

data/lib/cistern/version.rb

@@ -1,3 +1,3 @@
 module Cistern
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

data/spec/formatter_spec.rb

@@ -1,41 +1,75 @@
 require 'spec_helper'
 
-describe "#inspect" do
-  class Inspector < Sample::Model
-    identity :id
-    attribute :name
+class Inspector < Sample::Model
+  identity :id
+  attribute :name
+end
+
+class Anon < Sample::Model
+  attribute :chan
+end
+
+class Inspectors < Sample::Collection
+  model Inspector
+
+  def all(options={})
+    merge_attributes(options)
+    self.load([{id: 1, name: "2"},{id: 3, name: "4"}])
+  end
+end
+
+describe Cistern::Formatter::Default do
+  before { Cistern.formatter = described_class }
+
+  it "formats a model" do
+    expect(
+      Inspector.new(id: 1, name: "name").inspect
+    ).to match(
+      /<Inspector:0x[a-z0-9]+> {:id=>1, :name=>\"name\"}/
+    )
+
+    Anon.inspect
+  end
+
+  it "formats a collection" do
+    expect(
+      Inspectors.new.all.inspect
+    ).to match(
+      /<Inspectors:0x[a-z0-9]+> {} records/
+    )
   end
+end
 
-  class Inspectors < Sample::Collection
-    model Inspector
+describe Cistern::Formatter::AwesomePrint do
+  before { Cistern.formatter = described_class }
 
-    def all(options={})
-      merge_attributes(options)
-      self.load([{id: 1, name: "2"},{id: 3, name: "4"}])
-    end
+  it "formats a model" do
+    expect(
+      Inspector.new(id: 1, name: "name").inspect
+    ).to match(
+      /(?x-mi:\#<Inspector:0x[0-9a-f]+>\ {\n\ \ \ \ \ \ :id\x1B\[0;37m\ =>\ \x1B\[0m\x1B\[1;34m1\x1B\[0m,\n\ \ \ \ :name\x1B\[0;37m\ =>\ \x1B\[0m\x1B\[0;33m"name"\x1B\[0m\n})/
+    )
   end
 
-  describe "Cistern::Model" do
-    it "should use awesome_print" do
-      Cistern.formatter = Cistern::Formatter::AwesomePrint
+  it "formats a collection" do
+    expect(Inspectors.new.all.inspect).to match(/Inspectors\s+{.*}$/m) # close enough
+  end
+end
 
-      Inspector.new(id: 1, name: "name").inspect.match /(?x-mi:\#<Inspector:0x[0-9a-f]+>\ {\n\ \ \ \ \ \ :id\x1B\[0;37m\ =>\ \x1B\[0m\x1B\[1;34m1\x1B\[0m,\n\ \ \ \ :name\x1B\[0;37m\ =>\ \x1B\[0m\x1B\[0;33m"name"\x1B\[0m\n})/
-    end
+describe Cistern::Formatter::Formatador do
+  before { Cistern.formatter = described_class }
 
-    it "should use formatador" do
-      Cistern.formatter = Cistern::Formatter::Formatador
+  it "formats a model" do
+    Cistern.formatter = Cistern::Formatter::Formatador
 
-      expect(Inspector.new(id: 1, name: "name").inspect).to eq(%q{  <Inspector
+    expect(Inspector.new(id: 1, name: "name").inspect).to eq(%q{  <Inspector
     id=1,
     name="name"
   >})
-    end
   end
 
-  describe "Cistern::Collection" do
-    it "should use formatador" do
-      Cistern.formatter = Cistern::Formatter::Formatador
-      expect(Inspectors.new.all.inspect).to eq(%q{  <Inspectors
+  it "formats a collection" do
+    expect(Inspectors.new.all.inspect).to eq(%q{  <Inspectors
     [
       <Inspector
         id=1,
@@ -47,11 +81,5 @@ describe "#inspect" do
       >
     ]
   >})
-    end
-
-    it "should use awesome_print" do
-      Cistern.formatter = Cistern::Formatter::AwesomePrint
-      expect(Inspectors.new.all.inspect).to match(/Inspectors\s+{.*}$/m) # close enough
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cistern
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies: []
 description: API client framework extracted from Fog
 email:
@@ -36,6 +36,7 @@ files:
 - lib/cistern/data/redis.rb
 - lib/cistern/formatter.rb
 - lib/cistern/formatter/awesome_print.rb
+- lib/cistern/formatter/default.rb
 - lib/cistern/formatter/formatador.rb
 - lib/cistern/hash.rb
 - lib/cistern/mock.rb
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: API client framework
@@ -96,4 +97,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/service.rb
 - spec/wait_for_spec.rb
-has_rdoc: