unidom-common-rspec 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0d48e1ac08e611d4dd95378ee882855250685c7
-  data.tar.gz: 98f45cc9b4fc220ab9acb8e7fc5a9caa0b220d11
+  metadata.gz: 423975fbbd2d45be90dad54b10bb33d9fca86ca3
+  data.tar.gz: 972f708c3a3cd7ce84ce54dca26b7db5ac5d5f82
 SHA512:
-  metadata.gz: 856486f87c49af80c99b7e2b87fd205ec097d6be20eb9d70868518c669c4e3013e3ca646344fddc2aaef951aa4713a92e79782293e09e01969e4eed05f63d770
-  data.tar.gz: 930fb8d810301ce089166d29018ed08c9e50d3c3da630419aa384b7ef10b3205e9e180085840a0c3ccbfa5f1dacea4cbb00e8b941e66e0762b8edbb507f31efc
+  metadata.gz: fe7a08d3627566465e51b205c9936bfa8bb5b9c7523c9a6b100c9243d2a4e36c7a9f2e93c9e051d2e3825060f663e18fa7dd57d8ba92a8ec10d0350e2d52701e
+  data.tar.gz: aae6459986887bfb5d5002d0c42363910f7ffb86de2ae1dd52ffbce38c814002ded13906ecd42af120d778371c4996bd1c144e4687ec14c47c7079e5e00492ec

data/CHANGELOG.md

@@ -5,3 +5,6 @@
 
 ## v0.2
 1. Validates shared examples
+
+## v0.3
+1. Model Extension shared examples

data/README.md

@@ -51,18 +51,21 @@ describe Person, type: :model do
     it_behaves_like 'scope', :all, [
       { attributes_collection: [ model_attributes                            ], count_diff: 1, args: [] },
       { attributes_collection: [ model_attributes.merge(defunct:   true)     ], count_diff: 1, args: [] },
-      { attributes_collection: [ model_attributes.merge(closed_at: Time.now) ], count_diff: 1, args: [] } ]
+      { attributes_collection: [ model_attributes.merge(closed_at: Time.now) ], count_diff: 1, args: [] }
+    ]
 
     it_behaves_like 'scope', :none, [
       { attributes_collection: [ model_attributes                            ], count_diff: 0, args: [] },
       { attributes_collection: [ model_attributes.merge(defunct:   true)     ], count_diff: 0, args: [] },
-      { attributes_collection: [ model_attributes.merge(closed_at: Time.now) ], count_diff: 0, args: [] } ]
+      { attributes_collection: [ model_attributes.merge(closed_at: Time.now) ], count_diff: 0, args: [] }
+    ]
 
     it_behaves_like 'scope', :transited_to, [
       { attributes_collection: [ model_attributes                   ], count_diff: 1, args: [ 'C' ] },
       { attributes_collection: [ model_attributes                   ], count_diff: 0, args: [ 'A' ] },
       { attributes_collection: [ model_attributes.merge(state: 'A') ], count_diff: 0, args: [ 'C' ] },
-      { attributes_collection: [ model_attributes.merge(state: 'A') ], count_diff: 1, args: [ 'A' ] } ]
+      { attributes_collection: [ model_attributes.merge(state: 'A') ], count_diff: 1, args: [ 'A' ] }
+    ]
 
   end
 
@@ -96,7 +99,24 @@ describe Person, type: :model do
 end
 ```
 
+### Model Extension shared examples Model Extension 共享用例
 
+Assume the model class is ``Person``, and the model alread extend the ``Unidom::Common::Concerns::ModelExtension``, the ``person_spec.rb`` looks like the following:
+```ruby
+require 'rails_helper'
+
+describe Person, type: :model do
+
+  context do
+
+    tim_attributes = { name: 'Tim' }
+
+    it_behaves_like 'Unidom::Common::Concerns::ModelExtension', model_attributes
+
+  end
+
+end
+```
 
 ## Development
 

data/ROADMAP.md

@@ -5,3 +5,6 @@
 
 ## v0.2
 1. Validates shared examples
+
+## v0.3
+1. Model Extension shared examples

data/lib/unidom/common/rspec.rb

@@ -2,6 +2,7 @@ require "unidom/common/rspec/version"
 
 require 'unidom/common/rspec/scope_shared_examples'
 require 'unidom/common/rspec/validates_shared_examples'
+require 'unidom/common/rspec/model_extension_shared_examples'
 
 module Unidom
   module Common

data/lib/unidom/common/rspec/model_extension_shared_examples.rb

@@ -0,0 +1,314 @@
+shared_examples 'Unidom::Common::Concerns::ModelExtension' do |model_attributes|
+
+  # scopes for the #id column
+
+  describe '.included_by' do
+
+    id = SecureRandom.uuid
+
+    it_behaves_like 'scope', :included_by, [
+      { attributes_collection: [ model_attributes.merge(id: id) ], count_diff: 1, args: [ id                        ] },
+      { attributes_collection: [ model_attributes.merge(id: id) ], count_diff: 0, args: [ Unidom::Common::NULL_UUID ] }
+    ]
+
+  end
+
+  describe '.excluded_by' do
+
+    id = SecureRandom.uuid
+
+    it_behaves_like 'scope', :excluded_by, [
+      { attributes_collection: [ model_attributes.merge(id: id) ], count_diff: 0, args: [ id                        ] },
+      { attributes_collection: [ model_attributes.merge(id: id) ], count_diff: 1, args: [ Unidom::Common::NULL_UUID ] }
+    ]
+
+  end
+
+  # validations & scopes for the #state column
+
+  describe '#state' do
+
+    it 'column exists'           do expect(described_class.columns_hash['state']).to       be_present end
+    it 'column length must be 1' do expect(described_class.columns_hash['state'].limit).to eq(1)      end
+
+    it_behaves_like 'validates', model_attributes, :state,
+      {             } => 0,
+      { state: nil  } => 2,
+      { state: ''   } => 2,
+      { state: 'A'  } => 0,
+      { state: 'AA' } => 1
+
+  end
+
+  describe '.transited_to' do
+
+    it_behaves_like 'scope', :transited_to, [
+      { attributes_collection: [ model_attributes                   ], count_diff: 1, args: [ 'C' ] },
+      { attributes_collection: [ model_attributes                   ], count_diff: 0, args: [ 'A' ] },
+      { attributes_collection: [ model_attributes.merge(state: 'A') ], count_diff: 0, args: [ 'C' ] },
+      { attributes_collection: [ model_attributes.merge(state: 'A') ], count_diff: 1, args: [ 'A' ] }
+    ]
+
+  end
+
+  # scopes for the #opened_at column & the #closed_at column
+
+  describe '#opened_at' do
+    it 'column exists' do expect(described_class.columns_hash['opened_at']).to be_present end
+  end
+
+  describe '#closed_at' do
+    it 'column exists' do expect(described_class.columns_hash['closed_at']).to be_present end
+  end
+
+  describe '.valid_at' do
+
+    opened_at = Time.utc described_class.columns_hash['opened_at'].default
+    closed_at = Time.utc described_class.columns_hash['closed_at'].default
+
+    it_behaves_like 'scope', :valid_at, [
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ { now: opened_at-1.second } ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ { now: opened_at          } ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ { now: opened_at+1.second } ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ { now: closed_at-1.second } ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ { now: closed_at          } ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ { now: closed_at+1.second } ] }
+    ]
+
+    it_behaves_like 'scope', :valid_duration, [
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ opened_at-2.second..opened_at-1.second ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ opened_at-1.second..closed_at-1.second ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ opened_at-1.second..closed_at          ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ opened_at-1.second..closed_at+1.second ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ opened_at..closed_at-1.second          ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ opened_at..closed_at                   ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ opened_at..closed_at+1.second          ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ opened_at+1.second..closed_at-1.second ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ opened_at+1.second..closed_at          ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ opened_at+1.second..closed_at+1.second ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ closed_at+1.second..closed_at+2.second ] }
+    ]
+
+  end
+
+  # scopes for the #defunct column
+
+  describe '#defunct' do
+    it 'column exists' do expect(described_class.columns_hash['defunct']).to be_present end
+  end
+
+  describe '.alive' do
+
+    it_behaves_like 'scope', :alive, [
+      { attributes_collection: [ model_attributes                      ], count_diff: 1, args: [] },
+      { attributes_collection: [ model_attributes                      ], count_diff: 1, args: [ { living: true  } ] },
+      { attributes_collection: [ model_attributes                      ], count_diff: 0, args: [ { living: false } ] },
+      { attributes_collection: [ model_attributes.merge(defunct: true) ], count_diff: 0, args: [] },
+      { attributes_collection: [ model_attributes.merge(defunct: true) ], count_diff: 0, args: [ { living: true  } ] },
+      { attributes_collection: [ model_attributes.merge(defunct: true) ], count_diff: 1, args: [ { living: false } ] }
+    ]
+
+  end
+
+  describe '.dead' do
+
+    it_behaves_like 'scope', :dead, [
+      { attributes_collection: [ model_attributes                      ], count_diff: 0, args: [] },
+      { attributes_collection: [ model_attributes                      ], count_diff: 0, args: [ { defunct: true  } ] },
+      { attributes_collection: [ model_attributes                      ], count_diff: 1, args: [ { defunct: false } ] },
+      { attributes_collection: [ model_attributes.merge(defunct: true) ], count_diff: 1, args: [] },
+      { attributes_collection: [ model_attributes.merge(defunct: true) ], count_diff: 1, args: [ { defunct: true  } ] },
+      { attributes_collection: [ model_attributes.merge(defunct: true) ], count_diff: 0, args: [ { defunct: false } ] }
+    ]
+
+  end
+
+  # validations & scopes for the #ordinal column
+
+  ordinal_column = described_class.columns_hash['ordinal']
+
+  if ordinal_column.present?&&:integer==ordinal_column.type
+
+    it_behaves_like 'validates', model_attributes, :ordinal,
+      {               } => 3,
+      { ordinal: nil  } => 3,
+      { ordinal: ''   } => 3,
+      { ordinal: 'A'  } => 2,
+      { ordinal: 'AA' } => 2,
+      { ordinal: '0'  } => 1,
+      { ordinal: 0    } => 1,
+      { ordinal: -1   } => 1,
+      { ordinal: -11  } => 1,
+      { ordinal: 1.1  } => 1,
+      { ordinal: '1'  } => 0,
+      { ordinal: '11' } => 0,
+      { ordinal: 1    } => 0,
+      { ordinal: 11   } => 0
+
+    it_behaves_like 'scope', :ordinal_is, [
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:ordinal]-1 ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ model_attributes[:ordinal]   ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:ordinal]+1 ] }
+    ]
+
+  end
+
+  # validations & scopes for the #uuid column
+
+  uuid_column = described_class.columns_hash['uuid']
+
+  if uuid_column.present?
+
+    it_behaves_like 'validates', model_attributes, :uuid,
+      {            } => 2,
+      { uuid: nil  } => 2,
+      { uuid: ''   } => 2,
+      { uuid: 'A'  } => 1,
+      { uuid: 'AA' } => 1,
+      { uuid: Unidom::Common::NULL_UUID[0..34] } => 1,
+      { uuid: Unidom::Common::NULL_UUID        } => 1,
+      { uuid: "#{Unidom::Common::NULL_UUID}1"  } => 1
+
+    it_behaves_like 'scope', :uuid_is, [
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:uuid] ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ model_attributes[:uuid] ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:uuid] ] }
+    ]
+
+  end
+
+  # scopes for the #elemental column
+
+  elemental_column = described_class.columns_hash['elemental']
+
+  if elemental_column.present?
+
+    it_behaves_like 'scope', :primary, [
+      { attributes_collection: [ model_attributes.merge(elemental: true ) ], count_diff: 1, args: [ true  ] },
+      { attributes_collection: [ model_attributes.merge(elemental: true ) ], count_diff: 0, args: [ false ] },
+      { attributes_collection: [ model_attributes.merge(elemental: false) ], count_diff: 0, args: [ true  ] },
+      { attributes_collection: [ model_attributes.merge(elemental: false) ], count_diff: 1, args: [ false ] }
+    ]
+
+  end
+
+  # validations & scopes for the #grade column
+
+  grade_column = described_class.columns_hash['grade']
+
+  if grade_column.present?&&:integer==grade_column.type
+
+    it_behaves_like 'validates', model_attributes, :grade,
+      {             } => 3,
+      { grade: nil  } => 3,
+      { grade: ''   } => 3,
+      { grade: 'A'  } => 2,
+      { grade: 'AA' } => 2,
+      { grade: -1   } => 1,
+      { grade: -11  } => 1,
+      { grade: 1.1  } => 1,
+      { grade: '0'  } => 0,
+      { grade: '1'  } => 0,
+      { grade: '11' } => 0,
+      { grade: 0    } => 0,
+      { grade: 1    } => 0,
+      { grade: 11   } => 0
+
+    it_behaves_like 'scope', :grade_is, [
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:grade]-1 ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ model_attributes[:grade]   ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:grade]+1 ] }
+    ]
+
+    it_behaves_like 'scope', :grade_higher_than, [
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ model_attributes[:grade]-1 ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:grade]   ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:grade]+1 ] }
+    ]
+
+    it_behaves_like 'scope', :grade_lower_than, [
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:grade]-1 ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:grade]   ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ model_attributes[:grade]+1 ] }
+    ]
+
+  end
+
+  # validations & scopes for the #priority column
+
+  priority_column = described_class.columns_hash['priority']
+
+  if priority_column.present?&&:integer==priority_column.type
+
+    it_behaves_like 'validates', model_attributes, :priority,
+      {                } => 3,
+      { priority: nil  } => 3,
+      { priority: ''   } => 3,
+      { priority: 'A'  } => 2,
+      { priority: 'AA' } => 2,
+      { priority: -1   } => 1,
+      { priority: -11  } => 1,
+      { priority: 1.1  } => 1,
+      { priority: '0'  } => 0,
+      { priority: '1'  } => 0,
+      { priority: '11' } => 0,
+      { priority: 0    } => 0,
+      { priority: 1    } => 0,
+      { priority: 11   } => 0
+
+    it_behaves_like 'scope', :grade_is, [
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:priority]-1 ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ model_attributes[:priority]   ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:priority]+1 ] }
+    ]
+
+    it_behaves_like 'scope', :grade_higher_than, [
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ model_attributes[:priority]-1 ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:priority]   ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:priority]+1 ] }
+    ]
+
+    it_behaves_like 'scope', :grade_lower_than, [
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:priority]-1 ] },
+      { attributes_collection: [ model_attributes ], count_diff: 0, args: [ model_attributes[:priority]   ] },
+      { attributes_collection: [ model_attributes ], count_diff: 1, args: [ model_attributes[:priority]+1 ] }
+    ]
+
+  end
+
+  # scopes for the #slug column
+
+  slug_column = described_class.columns_hash['slug']
+
+  if slug_column.present?
+
+    slug = SecureRandom.uuid+SecureRandom.uuid
+
+    it_behaves_like 'scope', :slug_is, [
+      #{ attributes_collection: [ model_attributes.merge(slug: slug) ], count_diff: 1, args: [ slug        ] },
+      { attributes_collection: [ model_attributes.merge(slug: slug) ], count_diff: 0, args: [ "#{slug}1"  ] },
+      { attributes_collection: [ model_attributes.merge(slug: slug) ], count_diff: 0, args: [ slug[0..34] ] }
+    ]
+
+  end
+
+  # Active Record default scopes
+
+  context '.scope' do
+
+    it_behaves_like 'scope', :all, [
+      { attributes_collection: [ model_attributes                            ], count_diff: 1, args: [] },
+      { attributes_collection: [ model_attributes.merge(defunct:   true)     ], count_diff: 1, args: [] },
+      { attributes_collection: [ model_attributes.merge(closed_at: Time.now) ], count_diff: 1, args: [] }
+    ]
+
+    it_behaves_like 'scope', :none, [
+      { attributes_collection: [ model_attributes                            ], count_diff: 0, args: [] },
+      { attributes_collection: [ model_attributes.merge(defunct:   true)     ], count_diff: 0, args: [] },
+      { attributes_collection: [ model_attributes.merge(closed_at: Time.now) ], count_diff: 0, args: [] }
+    ]
+
+  end
+
+end

data/lib/unidom/common/rspec/validates_shared_examples.rb

@@ -32,4 +32,5 @@ shared_examples 'validates' do |model_attributes, attribute_name, error_attribut
     end
 
   end
+
 end

data/lib/unidom/common/rspec/version.rb

@@ -1,7 +1,7 @@
 module Unidom
   module Common
     module RSpec
-      VERSION = '0.2'
+      VERSION = '0.3'
     end
   end
 end

data/unidom-common-rspec.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake',    '~> 10.0'
-  spec.add_development_dependency 'rspec',   "~> 3.0"
+  spec.add_development_dependency 'rspec',   '~> 3.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-common-rspec
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-26 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -87,6 +87,7 @@ files:
 - bin/console
 - bin/setup
 - lib/unidom/common/rspec.rb
+- lib/unidom/common/rspec/model_extension_shared_examples.rb
 - lib/unidom/common/rspec/scope_shared_examples.rb
 - lib/unidom/common/rspec/validates_shared_examples.rb
 - lib/unidom/common/rspec/version.rb