cistern 2.2.7 → 2.3.0

data/lib/cistern/collection.rb

@@ -5,23 +5,48 @@ module Cistern::Collection
     :keep_if, :pop, :shift, :delete_at, :compact
   ].to_set # :nodoc:
 
-  def self.service_collection(service, klass, name)
-    service.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
+  def self.cistern_collection(cistern, klass, name)
+    cistern.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
       def #{name}(attributes={})
-        #{klass.name}.new(attributes.merge(service: self))
+        #{klass.name}.new(attributes.merge(cistern: self))
       end
     EOS
   end
 
-  attr_accessor :records, :loaded, :service
+  attr_accessor :records, :loaded, :cistern
+
+  def service=(service)
+    Cistern.deprecation(
+      '#service= is deprecated.  Please use #cistern=',
+      caller[0]
+    )
+    @cistern = service
+  end
+
+  def service
+    Cistern.deprecation(
+      '#service is deprecated.  Please use #cistern',
+      caller[0]
+    )
+    @cistern
+  end
 
   module ClassMethods
     def model(new_model = nil)
       @_model ||= new_model
     end
 
+    # @deprecated Use {#cistern_method} instead
     def service_method(name = nil)
-      @_service_method ||= name
+      Cistern.deprecation(
+        '#service_method is deprecated.  Please use #cistern_method',
+        caller[0]
+      )
+      @_cistern_method ||= name
+    end
+
+    def cistern_method(name = nil)
+      @_cistern_method ||= name
     end
   end
 
@@ -80,7 +105,7 @@ module Cistern::Collection
     model.new(
       {
         collection: self,
-        service: service
+        cistern: cistern,
       }.merge(attributes)
     )
   end

data/lib/cistern/model.rb

@@ -7,21 +7,46 @@ module Cistern::Model
     klass.send(:extend, Cistern::Model::ClassMethods)
   end
 
-  def self.service_model(service, klass, name)
-    service.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
+  def self.cistern_model(cistern, klass, name)
+    cistern.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
       def #{name}(attributes={})
-        #{klass.name}.new(attributes.merge(service: self))
+    #{klass.name}.new(attributes.merge(cistern: self))
       end
     EOS
   end
 
   module ClassMethods
+    # @deprecated Use {#cistern_method} instead
     def service_method(name = nil)
-      @_service_method ||= name
+      Cistern.deprecation(
+        '#service_method is deprecated.  Please use #cistern_method',
+        caller[0]
+      )
+      @_cistern_method ||= name
+    end
+
+    def cistern_method(name = nil)
+      @_cistern_method ||= name
     end
   end
 
-  attr_accessor :collection, :service
+  attr_accessor :collection, :cistern
+
+  def service=(service)
+    Cistern.deprecation(
+      '#service= is deprecated.  Please use #cistern=',
+      caller[0]
+    )
+    @cistern = service
+  end
+
+  def service
+    Cistern.deprecation(
+      '#service is deprecated.  Please use #cistern',
+      caller[0]
+    )
+    @cistern
+  end
 
   def inspect
     Cistern.formatter.call(self)
@@ -31,8 +56,10 @@ module Cistern::Model
     merge_attributes(attributes)
   end
 
+  # Merge #attributes and call {#save}.  Valid and change attributes are available in {#dirty_attributes}
+  # @param attributes [Hash]
   def update(attributes)
-    merge_attributes(attributes)
+    stage_attributes(attributes)
     save
   end
 
@@ -67,15 +94,23 @@ module Cistern::Model
     end
   end
 
-  def wait_for(timeout = service_class.timeout, interval = service_class.poll_interval, &block)
-    service_class.wait_for(timeout, interval) { reload && block.call(self) }
+  def wait_for(timeout = cistern_class.timeout, interval = cistern_class.poll_interval, &block)
+    cistern_class.wait_for(timeout, interval) { reload && block.call(self) }
   end
 
-  def wait_for!(timeout = service_class.timeout, interval = service_class.poll_interval, &block)
-    service_class.wait_for!(timeout, interval) { reload && block.call(self) }
+  def wait_for!(timeout = cistern_class.timeout, interval = cistern_class.poll_interval, &block)
+    cistern_class.wait_for!(timeout, interval) { reload && block.call(self) }
   end
 
   def service_class
-    service ? service.class : Cistern
+    Cistern.deprecation(
+      '#service_class is deprecated.  Please use #cistern_class',
+      caller[0]
+    )
+    cistern ? cistern.class : Cistern
+  end
+
+  def cistern_class
+    cistern ? cistern.class : Cistern
   end
 end

data/lib/cistern/request.rb

@@ -1,31 +1,56 @@
 module Cistern::Request
-  def self.service_request(service, klass, name)
-    unless klass.name
+  def self.cistern_request(cistern, klass, name)
+    unless klass.name || klass.cistern_method
       fail ArgumentError, "can't turn anonymous class into a Cistern request"
     end
 
-    service::Mock.module_eval <<-EOS, __FILE__, __LINE__
+    cistern::Mock.module_eval <<-EOS, __FILE__, __LINE__
       def #{name}(*args)
         #{klass}.new(self)._mock(*args)
       end
     EOS
 
-    service::Real.module_eval <<-EOS, __FILE__, __LINE__
+    cistern::Real.module_eval <<-EOS, __FILE__, __LINE__
       def #{name}(*args)
         #{klass}.new(self)._real(*args)
       end
     EOS
   end
 
-  attr_reader :service
+  def self.service_request(*args)
+    Cistern.deprecation(
+      '#service_request is deprecated.  Please use #cistern_request',
+      caller[0]
+    )
+    cistern_request(*args)
+  end
+
+  attr_reader :cistern
+
+  def service
+    Cistern.deprecation(
+      '#service is deprecated.  Please use #cistern',
+      caller[0]
+    )
+    @cistern
+  end
 
-  def initialize(service)
-    @service = service
+  def initialize(cistern)
+    @cistern = cistern
   end
 
   module ClassMethods
+    # @deprecated Use {#cistern_method} instead
     def service_method(name = nil)
-      @_service_method ||= name
+      Cistern.deprecation(
+        '#service_method is deprecated.  Please use #cistern_method',
+        caller[0]
+      )
+      @_cistern_method ||= name
+    end
+
+    def cistern_method(name = nil)
+      @_cistern_method ||= name
     end
   end
 end

data/lib/cistern/singular.rb

@@ -1,8 +1,8 @@
 module Cistern::Singular
-  def self.service_singular(service, klass, name)
-    service.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
+  def self.cistern_singular(cistern, klass, name)
+    cistern.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
       def #{name}(attributes={})
-        #{klass.name}.new(attributes.merge(service: self))
+    #{klass.name}.new(attributes.merge(cistern: self))
       end
     EOS
   end
@@ -13,7 +13,15 @@ module Cistern::Singular
     klass.send(:extend, Cistern::Model::ClassMethods)
   end
 
-  attr_accessor :service
+  attr_accessor :cistern
+
+  def service
+    Cistern.deprecation(
+      '#service is deprecated.  Please use #cistern',
+      caller[0]
+    )
+    @cistern
+  end
 
   def inspect
     Cistern.formatter.call(self)

data/lib/cistern/version.rb

@@ -1,3 +1,3 @@
 module Cistern
-  VERSION = '2.2.7'
+  VERSION = '2.3.0'
 end

data/spec/attributes_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe Cistern::Attributes, 'requires' do
+  class RequireSpec < Sample::Model
+    identity :id
+    attribute :name, type: :string
+    attribute :type
+  end
+
+  it 'raises if required attributes are not present' do
+    expect {
+      Sample.new.require_spec.requires :name
+    }.to raise_exception(ArgumentError, /name is required/)
+
+    data = { name: '1' }
+    return_value = Sample.new.require_spec(data).requires :name
+
+    expect(return_value).to eq(data)
+
+    expect {
+      Sample.new.require_spec.requires :name, :type
+    }.to raise_exception(ArgumentError, /name and type are required/)
+
+    data = { name: '1', type: 'sample' }
+    return_values = Sample.new.require_spec(data).requires :name, :type
+    expect(return_values).to eq(data)
+  end
+
+  it 'raises if a required attribute attribute is not present' do
+    expect {
+      Sample.new.require_spec.requires_one :name, :type
+    }.to raise_exception(ArgumentError, /name or type are required/)
+
+    data = { name: '1' }
+    return_value = Sample.new.require_spec(data).requires_one :name, :type
+
+    expect(return_value).to eq(data)
+
+    data = { name: '1', type: 'sample' }
+    return_values = Sample.new.require_spec(data).requires_one :name, :type
+    expect(return_values).to eq(data)
+  end
+end
+
+describe Cistern::Attributes, 'parsing' do
+  class TypeSpec < Sample::Model
+    identity :id
+    attribute :name, type: :string
+    attribute :created_at, type: :time
+    attribute :flag, type: :boolean
+    attribute :list, type: :array
+    attribute :number, type: :integer
+    attribute :floater, type: :float
+    attribute :butternut_id, squash: %w(squash id), type: :integer
+    attribute :butternut_type, squash: %w(squash type)
+    attribute :squash
+    attribute :vegetable, aliases: 'squash'
+    attribute :custom, parser: lambda { |v, _| "X!#{v}" }
+    attribute :default, default: 'im a squash'
+    attribute :string_allow_nil, type: :string, allow_nil: true
+
+    attribute :same_alias_1, aliases: 'nested'
+    attribute :same_alias_2, aliases: 'nested'
+
+    attribute :same_alias_squashed_1, squash: %w(nested attr_1)
+    attribute :same_alias_squashed_2, squash: %w(nested attr_2)
+    attribute :same_alias_squashed_3, squash: %w(nested attr_2)
+    attribute :adam_attributes, aliases: 'attributes'
+
+    def save
+      requires :flag
+    end
+  end
+
+  it 'should parse string' do
+    expect(TypeSpec.new(name: 1).name).to eq('1')
+    expect(TypeSpec.new(name: "b").name).to eq('b')
+    expect(TypeSpec.new(name: nil).name).to eq("")
+  end
+
+  it 'should allow nils in string types' do
+    expect(TypeSpec.new(string_allow_nil: nil).string_allow_nil).to eq(nil)
+  end
+  it "should handle a 'attributes' aliased attribute" do
+    expect(TypeSpec.new(attributes: 'x').adam_attributes).to eq('x')
+  end
+
+  it 'should parse time' do
+    time = Time.now
+    created_at = TypeSpec.new(created_at: time.to_s).created_at
+    expect(created_at).to be_a(Time)
+    expect(created_at.to_i).to eq(time.to_i)
+  end
+
+  it 'should parse boolean' do
+    expect(TypeSpec.new(flag: 'false').flag).to be_falsey
+    expect(TypeSpec.new(flag: 'true').flag).to be_truthy
+    expect(TypeSpec.new(flag: false).flag).to be_falsey
+    expect(TypeSpec.new(flag: true).flag).to be_truthy
+    expect(TypeSpec.new(flag: '0').flag).to be_falsey
+    expect(TypeSpec.new(flag: '1').flag).to be_truthy
+    expect(TypeSpec.new(flag: 0).flag).to be_falsey
+    expect(TypeSpec.new(flag: 1).flag).to be_truthy
+    expect(TypeSpec.new(flag: false)).not_to be_flag
+    expect(TypeSpec.new(flag: true)).to be_flag
+  end
+
+  it 'should parse an array' do
+    expect(TypeSpec.new(list: []).list).to eq([])
+    expect(TypeSpec.new(list: 'item').list).to eq(['item'])
+  end
+
+  it 'should parse a float' do
+    expect(TypeSpec.new(floater: '0.01').floater).to eq(0.01)
+    expect(TypeSpec.new(floater: 0.01).floater).to eq(0.01)
+  end
+
+  it 'should use custom parser' do
+    expect(TypeSpec.new(custom: '15').custom).to eq('X!15')
+  end
+
+  it 'should squash, cast, alias an attribute and keep a vanilla reference' do
+    # vanilla squash
+    expect(TypeSpec.new({ 'squash' => { 'id' => '12', 'type' => 'fred' } }).butternut_type).to eq('fred')
+    expect(TypeSpec.new({ 'squash' => { 'id' => '12', 'type' => nil } }).butternut_type).to be_nil
+    expect(TypeSpec.new({ 'squash' => nil }).butternut_type).to be_nil
+
+    # composite processors: squash and cast
+    expect(TypeSpec.new({ 'squash' => { 'id' => '12', 'type' => 'fred' } }).butternut_id).to eq(12)
+    expect(TypeSpec.new({ 'squash' => { 'id' => nil, 'type' => 'fred' } }).butternut_id).to be_nil
+    expect(TypeSpec.new({ 'squash' => { 'type' => 'fred' } }).butternut_id).to be_nil
+
+    # override intermediate processing
+    expect(TypeSpec.new({ 'squash' => { 'id' => '12', 'type' => 'fred' } }).squash).to eq({ 'id' => '12', 'type' => 'fred' })
+
+    # alias of override
+    expect(TypeSpec.new({ 'squash' => { 'id' => '12', 'type' => 'fred' } }).vegetable).to eq({ 'id' => '12', 'type' => 'fred' })
+  end
+
+  it 'should set a default value' do
+    expect(TypeSpec.new.default).to eq('im a squash')
+  end
+
+  it 'should override a default value' do
+    expect(TypeSpec.new(default: 'now im a different squash').default).to eq('now im a different squash')
+  end
+
+  context 'allowing the same alias for multiple attributes' do
+    it 'should do so when not squashing' do
+      type_spec = TypeSpec.new({ 'nested' => 'bamboo' })
+      expect(type_spec.same_alias_1).to eq('bamboo')
+      expect(type_spec.same_alias_2).to eq('bamboo')
+    end
+
+    it 'should do so when squashing' do
+      type_spec = TypeSpec.new({ 'nested' => { 'attr_1' => 'bamboo', 'attr_2' => 'panda' } })
+      expect(type_spec.same_alias_squashed_1).to eq('bamboo')
+      expect(type_spec.same_alias_squashed_2).to eq('panda')
+      expect(type_spec.same_alias_squashed_3).to eq('panda')
+    end
+  end
+
+  it 'should slice out unaccounted for attributes' do
+    expect(TypeSpec.new({ 'something' => { 'id' => '12' } }).attributes.keys).not_to include('something')
+  end
+end

data/spec/collection_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe 'Cistern::Collection' do
-  class SampleService < Cistern::Service
+  class SampleService
+    include Cistern::Client
   end
 
   class Drug < SampleService::Model
@@ -18,7 +19,7 @@ describe 'Cistern::Collection' do
   end
 
   class Tacs < SampleService::Collection
-    service_method :toes
+    cistern_method :toes
   end
 
   it 'should generate a default collection method' do
@@ -64,4 +65,19 @@ describe 'Cistern::Collection' do
   it 'should ==' do
     Drugs.new.all == Drugs.new.all
   end
+
+  describe 'deprecation', :deprecated do
+    class DeprecatedCollectionService
+      include Cistern::Client
+    end
+
+    it 'responds to #service' do
+      class DeprecationCollection < DeprecatedCollectionService::Collection
+        service_method :deprecator
+      end
+
+      sample = DeprecatedCollectionService.new.deprecator
+      expect(sample.service).to eq(sample.cistern)
+    end
+  end
 end