zyra 0.0.2 → 1.0.0

data/spec/lib/zyra_spec.rb

@@ -3,155 +3,19 @@
 require 'spec_helper'
 
 describe Zyra do
-  before { described_class.reset }
-
-  describe '.build' do
-    let(:model_class) { User }
-    let(:key)         { :user }
-
-    context 'when a builder has not been registered' do
-      it do
-        expect { described_class.build(key) }
-          .to raise_error(Zyra::Exceptions::BuilderNotRegistered)
-      end
-    end
-
-    context 'when a builder has been registered' do
-      before do
-        described_class.register(model_class)
-      end
-
-      it do
-        expect(described_class.build(key)).to be_a(model_class)
-      end
-
-      it do
-        expect(described_class.build(key))
-          .not_to be_persisted
-      end
-
-      context 'when attributes are given' do
-        let(:name) { SecureRandom.hex(10) }
+  let(:registry) { described_class }
 
-        it 'initializes the model with the given attribute' do
-          expect(described_class.build(key, name: name).name)
-            .to eq(name)
-        end
-      end
-
-      context 'when a block is given' do
-        let(:name) { SecureRandom.hex(10) }
-
-        it 'initializes the model with the given attribute' do
-          value = name
-          expect(described_class.build(key) { |model| model.name = value }.name)
-            .to eq(name)
-        end
-      end
-
-      context 'when building has an after build handler' do
-        let(:name) { SecureRandom.hex(10) }
-
-        before do
-          value = name
-          described_class.after(:user, :build) do |model|
-            model.name = value
-          end
-        end
+  before { described_class.reset }
 
-        it 'runs the event handler' do
-          expect(described_class.build(key) .name)
-            .to eq(name)
-        end
-      end
-    end
+  describe '.register' do
+    it_behaves_like 'a method that registers a finder creator'
   end
 
-  describe '.create' do
-    let(:model_class) { User }
-    let(:key)         { :user }
-
-    context 'when a builder has not been registered' do
-      it do
-        expect { described_class.create(key) }
-          .to raise_error(Zyra::Exceptions::BuilderNotRegistered)
-      end
-    end
-
-    context 'when a builder has been registered' do
-      before do
-        described_class.register(model_class)
-      end
-
-      it do
-        expect(described_class.create(key)).to be_a(model_class)
-      end
-
-      it do
-        expect(described_class.create(key))
-          .to be_persisted
-      end
-
-      context 'when attributes are given' do
-        let(:name) { SecureRandom.hex(10) }
-
-        it 'initializes the model with the given attribute' do
-          expect(described_class.create(key, name: name).name)
-            .to eq(name)
-        end
-      end
-
-      context 'when a block is given' do
-        let(:name) { SecureRandom.hex(10) }
-
-        it 'initializes the model with the given attribute' do
-          value = name
-          model = described_class.create(key) { |mdl| mdl.name = value }
-          expect(model.name)
-            .to eq(name)
-        end
-      end
-
-      context 'when building has an after build handler' do
-        let(:name) { SecureRandom.hex(10) }
-
-        before do
-          value = name
-          described_class.after(:user, :build) do |model|
-            model.name = value
-          end
-        end
-
-        it 'runs the event handler' do
-          expect(described_class.create(key) .name)
-            .to eq(name)
-        end
-      end
-    end
+  describe '.on' do
+    it_behaves_like 'a method that registers an event handler'
   end
 
-  describe '.after' do
-    let(:model_class) { User }
-    let(:key)         { :user }
-    let(:name)        { SecureRandom.hex(10) }
-
-    context 'when a builder has been registered' do
-      before do
-        described_class.register(model_class)
-      end
-
-      it 'register a handler to be ran after an event' do
-        value = name
-
-        expect { described_class.after(key, :build) { |m| m.name = value } }
-          .to change { described_class.build(key).name }
-          .from(nil).to(name)
-      end
-
-      it do
-        expect(described_class.after(key, :build) {})
-          .to be_a(Zyra::Builder)
-      end
-    end
+  describe '.find_or_create' do
+    it_behaves_like 'a method that returns or create a model'
   end
 end

data/spec/spec_helper.rb

@@ -10,6 +10,8 @@ SimpleCov.start 'gem'
 
 require 'zyra'
 require 'pry-nav'
+require 'factory_bot'
+require 'database_cleaner'
 
 require 'active_record'
 ActiveRecord::Base.establish_connection(
@@ -26,6 +28,17 @@ RSpec.configure do |config|
   config.filter_run_excluding :integration unless ENV['ALL']
 
   config.order = 'random'
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
 end
 
 RSpec::Matchers.define_negated_matcher :not_change, :change

data/spec/support/factories/user.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user, class: '::User' do
+    sequence(:name)  { |n| "Name-#{n}" }
+    sequence(:email) { |n| "user-#{n}@email.com" }
+    password         { SecureRandom.hex(10) }
+  end
+end

data/spec/support/factory_bot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end
+
+FactoryBot.find_definitions

data/spec/support/models/post.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Post < ActiveRecord::Base
+  belongs_to :user
+end

data/spec/support/models/user.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 class User < ActiveRecord::Base
+  has_many :posts
 end

data/spec/support/schema.rb

@@ -6,5 +6,13 @@ ActiveRecord::Schema.define do
   create_table :users, force: true do |t|
     t.string :name
     t.string :email
+    t.string :password
+    t.string :reference
+  end
+
+  create_table :posts, force: true do |t|
+    t.integer :user_id
+    t.string :name
+    t.text :content
   end
 end

data/spec/support/shared_examples/registry/find_or_create.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+shared_examples 'a method that returns or create a model' do
+  let(:key)         { :user }
+  let(:email)       { SecureRandom.hex(10) }
+  let(:model_class) { User }
+
+  let(:attributes) do
+    {
+      name: 'Some Name',
+      email: email,
+      password: 'SomePassword'
+    }
+  end
+
+  context 'when the model has not been registered' do
+    it do
+      expect { registry.find_or_create(key, attributes) }
+        .to raise_error(Zyra::Exceptions::NotRegistered)
+    end
+  end
+
+  context 'when the model has been registered' do
+    before do
+      registry.register(model_class, find_by: :email)
+    end
+
+    context 'when there is no entry in the database' do
+      it do
+        expect(registry.find_or_create(key, attributes))
+          .to be_a(model_class)
+      end
+
+      it do
+        expect { registry.find_or_create(key, attributes) }
+          .to change(model_class, :count)
+      end
+    end
+
+    context 'when the entry is there with the same attributes' do
+      let!(:user) { create(:user, **attributes) }
+
+      it 'returns the user' do
+        expect(registry.find_or_create(key, attributes)).to eq(user)
+      end
+    end
+
+    context 'when the entry is there with other attributes' do
+      let!(:user) { create(:user, email: email) }
+
+      it 'returns the user' do
+        expect(registry.find_or_create(key, attributes)).to eq(user)
+      end
+    end
+
+    context 'when there is another entry' do
+      before { create(:user) }
+
+      it 'returns a new model' do
+        expect(registry.find_or_create(key, attributes))
+          .to be_a(model_class)
+      end
+
+      it do
+        expect { registry.find_or_create(key, attributes) }
+          .to change(model_class, :count)
+      end
+    end
+
+    context 'when the keys is set as string' do
+      let(:keys)  { 'email' }
+      let!(:user) { create(:user, **attributes) }
+
+      it 'finds the user the same way' do
+        expect(registry.find_or_create(key, attributes)).to eq(user)
+      end
+    end
+
+    context 'when the attributes have string keys' do
+      let(:attributes) { { 'email' => email } }
+      let!(:user)      { create(:user, **attributes) }
+
+      it 'finds the user the same way' do
+        expect(registry.find_or_create(key, attributes)).to eq(user)
+      end
+    end
+
+    context 'when there is an event handler and it is triggered' do
+      let(:name) { 'new_name' }
+
+      let!(:user) { create(:user, **attributes) }
+
+      before do
+        new_name = name
+
+        registry.on(:user, :found) do |model|
+          model.update(name: new_name)
+        end
+      end
+
+      it 'runs the event after the model was found' do
+        expect { registry.find_or_create(key, attributes) }
+          .to change { user.reload.name }
+          .to(name)
+      end
+    end
+
+    context 'when there is an event handler and it is not triggered' do
+      let(:name) { 'new_name' }
+
+      before do
+        new_name = name
+
+        registry.on(:user, :found) do |model|
+          model.update(name: new_name)
+        end
+      end
+
+      it do
+        expect(registry.find_or_create(key, attributes))
+          .to be_a(model_class)
+      end
+
+      it do
+        expect { registry.find_or_create(key, attributes) }
+          .to change(model_class, :count)
+      end
+    end
+  end
+end

data/spec/support/shared_examples/registry/on.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+shared_examples 'a method that registers an event handler' do
+  let(:model_class) { User }
+  let(:key)         { :user }
+  let(:name)        { SecureRandom.hex(10) }
+
+  let(:attributes) do
+    {
+      name: 'Some Name',
+      email: 'someemail@srv.com',
+      password: 'SomePassword'
+    }
+  end
+
+  context 'when a creator has not been registered' do
+    it do
+      expect { registry.on(key, :found) {} }
+        .to raise_error(Zyra::Exceptions::NotRegistered)
+    end
+  end
+
+  context 'when a creator has been registered' do
+    before do
+      create(:user, **attributes)
+      registry.register(model_class, find_by: :email)
+    end
+
+    it 'register a handler to be ran after an event' do
+      value = name
+
+      expect { registry.on(key, :found) { |m| m.name = value } }
+        .to change { registry.find_or_create(key, attributes).name }
+        .from('Some Name').to(name)
+    end
+
+    it do
+      expect(registry.on(key, :build) {})
+        .to be_a(Zyra::FinderCreator)
+    end
+  end
+end

data/spec/support/shared_examples/registry/register.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+shared_examples 'a method that registers a finder creator' do
+  let(:recovery_key) { [key.to_s, key.to_sym].sample }
+  let(:attributes)   { { email: 'email@srv.com' } }
+
+  context 'when providing symbol alias' do
+    let(:key) { :user_alias }
+
+    it 'creates a creator for the given class' do
+      expect(registry.register(User, key, find_by: :email))
+        .to eq(Zyra::FinderCreator.new(User, [:email]))
+    end
+
+    it 'register creator under the key' do
+      registry.register(User, key, find_by: :email)
+
+      expect(registry.find_or_create(recovery_key, attributes))
+        .to be_a(User)
+    end
+  end
+
+  context 'when providing string alias' do
+    let(:key) { 'user' }
+
+    it 'creates a creator for the given class' do
+      expect(registry.register(User, key, find_by: :email))
+        .to eq(Zyra::FinderCreator.new(User, [:email]))
+    end
+
+    it 'register creator under the key' do
+      registry.register(User, key, find_by: :email)
+
+      expect(registry.find_or_create(recovery_key, attributes))
+        .to be_a(User)
+    end
+  end
+
+  context 'when not providing an alias' do
+    let(:key) { :user }
+
+    it 'creates a creator for the given class' do
+      expect(registry.register(User, find_by: :email))
+        .to eq(Zyra::FinderCreator.new(User, [:email]))
+    end
+
+    it 'register creator under the correct key' do
+      registry.register(User, key, find_by: :email)
+
+      expect(registry.find_or_create(recovery_key, attributes))
+        .to be_a(User)
+    end
+  end
+end

data/zyra.gemspec

@@ -19,11 +19,13 @@ Gem::Specification.new do |gem|
   gem.test_files            = gem.files.grep(%r{^(test|gem|features)/})
   gem.require_paths         = ['lib']
 
+  gem.add_runtime_dependency     'activesupport',      '~> 5.2.0'
   gem.add_runtime_dependency     'jace',               '>= 0.1.1'
-  gem.add_runtime_dependency     'sinclair',           '>= 1.8.0'
 
   gem.add_development_dependency 'activerecord',       '5.2.8.1'
   gem.add_development_dependency 'bundler',            '2.3.20'
+  gem.add_development_dependency 'database_cleaner',   '1.8.3'
+  gem.add_development_dependency 'factory_bot',        '6.2.1'
   gem.add_development_dependency 'pry',                '0.14.1'
   gem.add_development_dependency 'pry-nav',            '1.0.0'
   gem.add_development_dependency 'rake',               '13.0.1'

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: zyra
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-01 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jace
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
-  name: sinclair
+  name: jace
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.3.20
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.2.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -314,20 +342,33 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/zyra.rb
-- lib/zyra/builder.rb
+- lib/zyra/creator.rb
 - lib/zyra/exceptions.rb
+- lib/zyra/finder.rb
+- lib/zyra/finder_creator.rb
 - lib/zyra/registry.rb
 - lib/zyra/version.rb
 - spec/integration/readme/.keep
+- spec/integration/readme/zyra_spec.rb
 - spec/integration/yard/.keep
-- spec/lib/zyra/builder_spec.rb
+- spec/integration/yard/zyra/registry_spec.rb
+- spec/integration/yard/zyra_spec.rb
+- spec/lib/zyra/creator_spec.rb
+- spec/lib/zyra/finder_creator_spec.rb
+- spec/lib/zyra/finder_spec.rb
 - spec/lib/zyra/registry_spec.rb
 - spec/lib/zyra_spec.rb
 - spec/spec_helper.rb
+- spec/support/factories/user.rb
+- spec/support/factory_bot.rb
 - spec/support/models/.keep
+- spec/support/models/post.rb
 - spec/support/models/user.rb
 - spec/support/schema.rb
 - spec/support/shared_examples/.keep
+- spec/support/shared_examples/registry/find_or_create.rb
+- spec/support/shared_examples/registry/on.rb
+- spec/support/shared_examples/registry/register.rb
 - zyra.gemspec
 - zyra.jpg
 homepage: https://github.com/darthjee/zyra