cistern 0.3.2 → 0.5.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c39b9ac9a702497cd0fd82279e908697d2d8e65
+  data.tar.gz: 7b9aae264e94c4dd5c5d883a697cf038659be657
+SHA512:
+  metadata.gz: 8441ed13d9b55f0f1cf988ec91a47914174388bed261811fa9c4a5d65cea727c8252a65fc1af22b75187f5c044fa1a058c109ed9693efb4ef1606fbfa5039ad1
+  data.tar.gz: 258a085c417051866346609af569a7269d173d8652fae7906bb365884c4d60fb493a9d2d5f9feaab336566a5efc7f9dcc8c2749a5644be336381c28b858932b6

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - "2.1.1"
+  - "1.9.3"
+  - "jruby-19mode"
+bundler_args: "--without development"
+before_install:
+  - "gem install bundler -v 1.5.2"
+script: "bundle exec rake --trace"
+notifications:
+  email:
+    on_success: never
+    on_failure: change

data/Gemfile

@@ -1,18 +1,17 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in cistern.gemspec
+# Specify your gem"s dependencies in cistern.gemspec
 gemspec
 
 group :test do
-  gem "rspec", "~> 2.0"
   gem "guard-rspec"
+  gem "pry-nav"
   gem "rake"
-  gem 'rb-fsevent', '~> 0.9.1'
-  gem 'pry-nav'
+  gem "rspec", "~> 2.0"
 end
 
 group :formatters do
-  gem 'formatador'
-  gem 'awesome_print'
+  gem "formatador"
+  gem "awesome_print"
 end
 

data/Guardfile

@@ -1,4 +1,4 @@
-guard 'rspec' do
+guard 'rspec', cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { "spec" }
   watch('spec/spec_helper.rb')  { "spec" }

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Josh Lane
+Copyright (c) 2014 Josh Lane
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -90,8 +90,11 @@ class Foo::Client::Bar < Cistern::Model
     }
 
     if new_record?
-      request_attributes = connection.create_bar(params).body["request"]
-      merge_attributes(new_attributes)
+      merge_attributes(connection.create_bar(params).body["bar"])
+    else
+      requires :identity
+
+      merge_attributes(connection.update_bar(params).body["bar"])
     end
   end
 end
@@ -111,10 +114,10 @@ class Foo::Client::Bars < Cistern::Collection
   def all(params = {})
     response = connection.get_bars(params)
 
-    data = self.clone.load(response.body["bars"])
+    data = response.body
 
-    collection.attributes.clear
-    collection.merge_attributes(data)
+    self.load(data["bars"])     # store bar records in collection
+    self.merge_attributes(data) # store any other attributes of the response on the collection
   end
 
   def discover(provisioned_id, options={})

data/cistern.gemspec

@@ -6,6 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["me@joshualane.com"]
   gem.description   = %q{API client framework extracted from Fog}
   gem.summary       = %q{API client framework}
+  gem.license       = "MIT"
   gem.homepage      = "http://joshualane.com/cistern"
 
   gem.files         = `git ls-files`.split($\)

data/lib/cistern/attributes.rb

@@ -1,12 +1,12 @@
 module Cistern::Attributes
   def self.parsers
     @parsers ||= {
-      :string  => lambda{|v,opts| v.to_s},
-      :time    => lambda{|v,opts| v.is_a?(Time) ? v : v && Time.parse(v.to_s)},
-      :integer => lambda{|v,opts| v && v.to_i},
-      :float   => lambda{|v,opts| v && v.to_f},
-      :array   => lambda{|v,opts| [*v]},
-      :boolean => lambda{|v,opts| ['true', '1'].include?(v.to_s.downcase)}
+      :string  => lambda { |v,opts| v.to_s },
+      :time    => lambda { |v,opts| v.is_a?(Time) ? v : v && Time.parse(v.to_s) },
+      :integer => lambda { |v,opts| v && v.to_i },
+      :float   => lambda { |v,opts| v && v.to_f },
+      :array   => lambda { |v,opts| [*v] },
+      :boolean => lambda { |v,opts| ['true', '1'].include?(v.to_s.downcase) }
     }
   end
 
@@ -14,7 +14,17 @@ module Cistern::Attributes
     @transforms ||= {
       :squash  => Proc.new do |k, v, options|
         squash = options[:squash]
-        if v.is_a?(::Hash)
+        if v.is_a?(::Hash) && squash.is_a?(Array)
+          travel = lambda do |tree, path|
+            if tree.is_a?(::Hash)
+              subtree = tree[path.shift]
+              travel.call(subtree, path)
+            else tree
+            end
+          end
+
+          travel.call(v, squash.dup)
+        elsif v.is_a?(::Hash)
           if v.key?(squash.to_s.to_sym)
             v[squash.to_s.to_sym]
           elsif v.has_key?(squash.to_s)
@@ -25,12 +35,12 @@ module Cistern::Attributes
         else v
         end
       end,
-      :none => lambda{|k, v, opts| v},
+      :none => lambda { |k, v, opts| v },
     }
   end
 
   def self.default_parser
-    @default_parser ||= lambda{|v, opts| v}
+    @default_parser ||= lambda { |v, opts| v }
   end
 
   module ClassMethods
@@ -43,10 +53,12 @@ module Cistern::Attributes
     end
 
     def attributes
-      @attributes ||= []
+      @attributes ||= {}
     end
 
-    def attribute(name, options = {})
+    def attribute(_name, options = {})
+      name = _name.to_s.to_sym
+
       parser = Cistern::Attributes.parsers[options[:type]] ||
         options[:parser] ||
         Cistern::Attributes.default_parser
@@ -62,8 +74,11 @@ module Cistern::Attributes
         attributes[name.to_s.to_sym]= parser.call(transformed, options)
       end
 
-      @attributes ||= []
-      @attributes |= [name]
+      if self.attributes[name]
+        raise(ArgumentError, "#{self.name} attribute[#{_name}] specified more than once")
+      else
+        self.attributes[name] = options
+      end
 
       Array(options[:aliases]).each do |new_alias|
         aliases[new_alias] ||= []
@@ -113,16 +128,22 @@ module Cistern::Attributes
     end
 
     def merge_attributes(new_attributes = {})
-      for key, value in new_attributes
+      new_attributes.each do |key, value|
+        # find nested paths
+        value.is_a?(::Hash) && self.class.attributes.each do |name, options|
+          if (options[:squash] || []).first == key
+            send("#{name}=", {key => value})
+          end
+        end
         unless self.class.ignored_attributes.include?(key)
           if self.class.aliases.has_key?(key)
             self.class.aliases[key].each do |aliased_key|
               send("#{aliased_key}=", value)
             end
-          elsif self.respond_to?("#{key}=", true)
+          end
+
+          if self.respond_to?("#{key}=", true)
             send("#{key}=", value)
-          else
-            # ignore data: unknown attribute : attributes[key] = value
           end
         end
       end

data/lib/cistern/collection.rb

@@ -1,21 +1,14 @@
-class Cistern::Collection < Array
+class Cistern::Collection
   extend Cistern::Attributes::ClassMethods
   include Cistern::Attributes::InstanceMethods
 
-  %w[reject select slice].each do |method|
-    define_method(method) do |*args, &block|
-      lazy_load unless @loaded
-      data = super(*args, &block)
-      self.clone.clear.concat(data)
-    end
-  end
+  BLACKLISTED_ARRAY_METHODS = [
+    :compact!, :flatten!, :reject!, :reverse!, :rotate!, :map!,
+    :shuffle!, :slice!, :sort!, :sort_by!, :delete_if,
+    :keep_if, :pop, :shift, :delete_at, :compact
+  ].to_set # :nodoc:
 
-  %w[first last size count to_s].each do |method|
-    define_method(method) do
-      lazy_load unless @loaded
-      super()
-    end
-  end
+  attr_accessor :records, :loaded, :connection
 
   def self.model(new_model=nil)
     if new_model == nil
@@ -25,18 +18,14 @@ class Cistern::Collection < Array
     end
   end
 
-  attr_accessor :connection
-
   alias build initialize
 
   def initialize(attributes = {})
-    @loaded = false
     merge_attributes(attributes)
   end
 
-  def clear
-    @loaded = true
-    super
+  def all(identity)
+    raise NotImplementedError
   end
 
   def create(attributes={})
@@ -47,21 +36,29 @@ class Cistern::Collection < Array
     raise NotImplementedError
   end
 
+  def clear
+    self.loaded = false
+    records && records.clear
+  end
+
   def inspect
-    lazy_load unless @loaded
-    Cistern.formatter.call(self)
+    if Cistern.formatter
+      Cistern.formatter.call(self)
+    else super
+    end
   end
 
   # @api private
-  def lazy_load
-    self.all
+  def load_records
+    self.all unless self.loaded
   end
 
+  # Should be called within #all to load records into the collection
+  # @param [Array<Hash>] objects list of record attributes to be loaded
+  # @return self
   def load(objects)
-    clear
-    for object in objects
-      self << new(object)
-    end
+    self.records = (objects || []).map { |object| new(object) }
+    self.loaded = true
     self
   end
 
@@ -83,7 +80,36 @@ class Cistern::Collection < Array
 
   def reload
     clear
-    lazy_load
+    load_records
     self
   end
+
+  def to_a
+    load_records
+    self.records || []
+  end
+
+  def respond_to?(method, include_private = false)
+    super || array_delegable?(method)
+  end
+
+  def ==(comparison_object)
+    comparison_object.equal?(self) ||
+      (comparison_object.is_a?(self.class) &&
+       comparison_object.to_a == self.to_a)
+  end
+
+  protected
+
+  def array_delegable?(method)
+    Array.method_defined?(method) && !BLACKLISTED_ARRAY_METHODS.include?(method)
+  end
+
+  def method_missing(method, *args, &block)
+    if array_delegable?(method)
+      to_a.public_send(method, *args, &block)
+    else
+      super
+    end
+  end
 end

data/lib/cistern/formatter/awesome_print.rb

@@ -32,7 +32,7 @@ module AwesomePrint::Cistern
   # Format Cistern::Model
   #------------------------------------------------------------------------------
   def awesome_cistern_collection(object)
-    "#{object.class.name} " << awesome_array(object)
+    "#{object.class.name} " << awesome_hash(attributes: object.attributes, records: object.records)
   end
 end
 

data/lib/cistern/formatter/formatador.rb

@@ -15,7 +15,7 @@ module Cistern::Formatter::Formatador
     Thread.current[:formatador].indent do
       unless model.class.attributes.empty?
         data << "\n#{Thread.current[:formatador].indentation}"
-        data << model.class.attributes.map {|attribute| "#{attribute}=#{model.send(attribute).inspect}"}.join(",\n#{Thread.current[:formatador].indentation}")
+        data << model.class.attributes.map { |attribute, _| "#{attribute}=#{model.send(attribute).inspect}" }.join(",\n#{Thread.current[:formatador].indentation}")
       end
     end
     data << "\n#{Thread.current[:formatador].indentation}>"

data/lib/cistern/formatter.rb

@@ -8,7 +8,6 @@ module Cistern::Formatter
       Cistern::Formatter::AwesomePrint
     elsif defined?(::Formatador)
       Cistern::Formatter::Formatador
-    else Cistern::Formatter::Default
     end
   end
 end

data/lib/cistern/mock.rb

@@ -1,7 +1,7 @@
 module Cistern
   class Mock
-    def self.not_implemented
-      raise NotImplementedError
+    def self.not_implemented(method="")
+      raise NotImplementedError, method ? "The call '#{method}' is not implemented" : ""
     end
 
     def self.random_hex(length)

data/lib/cistern/model.rb

@@ -5,7 +5,11 @@ class Cistern::Model
   attr_accessor :collection, :connection
 
   def inspect
-    Cistern.formatter.call(self)
+    if Cistern.formatter
+      Cistern.formatter.call(self)
+    else
+      "#<#{self.class} #{self.identity}"
+    end
   end
 
   def initialize(attributes={})
@@ -28,8 +32,8 @@ class Cistern::Model
 
   def ==(comparison_object)
     comparison_object.equal?(self) ||
-      (comparison_object.is_a?(self.class) && 
-       comparison_object.identity == self.identity && 
+      (comparison_object.is_a?(self.class) &&
+       comparison_object.identity == self.identity &&
        !comparison_object.new_record?)
   end
 

data/lib/cistern/service.rb

@@ -121,7 +121,7 @@ class Cistern::Service
           else
             service::Mock.module_eval <<-EOS, __FILE__, __LINE__
               def #{request}(*args)
-                Cistern::Mock.not_implemented
+                Cistern::Mock.not_implemented(request)
               end
             EOS
           end

data/lib/cistern/version.rb

@@ -1,3 +1,3 @@
 module Cistern
-  VERSION = "0.3.2"
+  VERSION = "0.5.4"
 end

data/lib/cistern.rb

@@ -1,5 +1,7 @@
 require 'cistern/version'
+
 require 'time'
+require 'set'
 
 module Cistern
 
@@ -15,7 +17,6 @@ module Cistern
   require 'cistern/service'
 
   extend WaitFor
-  timeout_error = Timeout
 
   autoload :Formatter, 'cistern/formatter'
 

data/spec/cistern_spec.rb

@@ -5,25 +5,18 @@ describe "#inspect" do
     identity :id
     attribute :name
   end
+
   class Inspectors < Cistern::Collection
+
     model Inspector
 
-    def all
+    def all(options={})
+      merge_attributes(options)
       self.load([{id: 1, name: "2"},{id: 3, name: "4"}])
     end
   end
 
-  before(:all) do
-    Cistern.formatter = Cistern::Formatter::Default
-  end
-
   describe "Cistern::Model" do
-    it "should use default" do
-      Cistern.formatter = Cistern::Formatter::Default
-
-      Inspector.new(id: 1, name: "name").inspect.should match /#<Inspector:0x[0-9a-f]+ attributes={id:1,name:\"name\"}/
-    end
-
     it "should use awesome_print" do
       Cistern.formatter = Cistern::Formatter::AwesomePrint
 
@@ -41,7 +34,8 @@ describe "#inspect" do
   end
 
   describe "Cistern::Collection" do
-    it "should use default" do
+    it "should use formatador" do
+      Cistern.formatter = Cistern::Formatter::Formatador
       Inspectors.new.all.inspect.should == %q{  <Inspectors
     [
       <Inspector
@@ -55,10 +49,10 @@ describe "#inspect" do
     ]
   >}
     end
+
     it "should use awesome_print" do
       Cistern.formatter = Cistern::Formatter::AwesomePrint
-      Inspectors.new.all.inspect.should match(/Inspectors\s+\[.*\]$/m) # close enough
+      Inspectors.new.all.inspect.should match(/Inspectors\s+{.*}$/m) # close enough
     end
-    it "should use formatador"
   end
 end

data/spec/model_spec.rb

@@ -28,15 +28,18 @@ describe "Cistern::Model" do
       attribute :list, type: :array
       attribute :number, type: :integer
       attribute :floater, type: :float
-      attribute :butternut, type: :integer, aliases: "squash", squash: "id"
-      attribute :custom, parser: lambda{|v, opts| "X!#{v}"}
+      attribute :butternut_id, squash: ["squash", "id"], type: :integer
+      attribute :butternut_type, squash: ["squash", "type"]
+      attribute :squash
+      attribute :vegetable, aliases: "squash"
+      attribute :custom, parser: lambda { |v, _| "X!#{v}" }
 
       attribute :same_alias_1, aliases: "nested"
       attribute :same_alias_2, aliases: "nested"
 
-      attribute :same_alias_squashed_1, aliases: "nested", squash: "attr_1"
-      attribute :same_alias_squashed_2, aliases: "nested", squash: "attr_2"
-      attribute :same_alias_squashed_3, aliases: "nested", squash: "attr_2"
+      attribute :same_alias_squashed_1, squash: ["nested", "attr_1"]
+      attribute :same_alias_squashed_2, squash: ["nested", "attr_2"]
+      attribute :same_alias_squashed_3, squash: ["nested", "attr_2"]
 
       def save
         requires :flag
@@ -79,8 +82,22 @@ describe "Cistern::Model" do
       TypeSpec.new(custom: "15").custom.should == "X!15"
     end
 
-    it "should squash and cast" do
-      TypeSpec.new({"squash" => {"id" => "12"}}).butternut.should == 12
+    it "should squash, cast, alias an attribute and keep a vanilla reference" do
+      # vanilla squash
+      TypeSpec.new({"squash" => {"id" => "12", "type" => "fred"}}).butternut_type.should == "fred"
+      TypeSpec.new({"squash" => {"id" => "12", "type" => nil}}).butternut_type.should be_nil
+      TypeSpec.new({"squash" => nil}).butternut_type.should be_nil
+
+      # composite processors: squash and cast
+      TypeSpec.new({"squash" => {"id" => "12", "type" => "fred"}}).butternut_id.should == 12
+      TypeSpec.new({"squash" => {"id" => nil, "type" => "fred"}}).butternut_id.should be_nil
+      TypeSpec.new({"squash" => {"type" => "fred"}}).butternut_id.should be_nil
+
+      # override intermediate processing
+      TypeSpec.new({"squash" => {"id" => "12", "type" => "fred"}}).squash.should == {"id" => "12", "type" => "fred"}
+
+      # alias of override
+      TypeSpec.new({"squash" => {"id" => "12", "type" => "fred"}}).vegetable.should == {"id" => "12", "type" => "fred"}
     end
 
     context "allowing the same alias for multiple attributes" do

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cistern
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.5.4
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies: []
 description: API client framework extracted from Fog
 email:
@@ -18,10 +17,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - TODO.md
@@ -31,7 +31,6 @@ files:
 - lib/cistern/collection.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
@@ -46,28 +45,28 @@ files:
 - spec/spec_helper.rb
 - spec/wait_for_spec.rb
 homepage: http://joshualane.com/cistern
-licenses: []
+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.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: API client framework
 test_files:
 - spec/cistern_spec.rb
@@ -75,4 +74,3 @@ test_files:
 - spec/model_spec.rb
 - spec/spec_helper.rb
 - spec/wait_for_spec.rb
-has_rdoc: 

data/lib/cistern/formatter/default.rb

@@ -1,5 +0,0 @@
-module Cistern::Formatter::Default
-  def self.call(obj)
-    "#<%s:0x%x attributes={%s}>" % [obj.class, obj.object_id.abs*2, obj.attributes.map{|k,v| "#{k}:#{v.inspect}"}.join(",")]
-  end
-end