upgrow 0.0.1 → 0.0.2

data/test/upgrow/documentation_test.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'yard'
+
+module Upgrow
+  class DocumentationTest < ActiveSupport::TestCase
+    test 'documentation is correctly written' do
+      assert_empty(%x(bundle exec yard --no-save --no-output --no-stats))
+    end
+  end
+end

data/test/upgrow/immutable_object_test.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Upgrow
+  class ImmutableObjectTest < ActiveSupport::TestCase
+    class Sample < ImmutableObject
+      attribute :title
+      attribute :body
+    end
+
+    class SubSample < Sample
+      attribute :name
+    end
+
+    test '.attribute_names is empty by default' do
+      assert_empty ImmutableObject.attribute_names
+    end
+
+    test '.attribute_names returns a list of attribute names' do
+      assert_equal [:title, :body, :name], SubSample.attribute_names
+    end
+
+    test '.new creates a frozen instance with the given attributes' do
+      sample = Sample.new(title: 'volmer', body: 'hello')
+
+      assert_equal 'volmer', sample.title
+      assert_equal 'hello', sample.body
+      assert sample.frozen?
+    end
+
+    test 'it does not allow members to be mutated' do
+      sample = Sample.new(title: 'volmer', body: 'hello')
+
+      refute sample.respond_to?(:title=)
+      refute sample.respond_to?(:body=)
+    end
+
+    test '.new rejects attributes that do not exist' do
+      error = assert_raises(ArgumentError) do
+        Sample.new(title: 'volmer', body: 'hello', fake: 'error')
+      end
+
+      assert_equal 'Unknown attribute [:fake]', error.message
+    end
+
+    test '.new requires inherited attributes' do
+      sub_sample = SubSample.new(title: 'volmer', body: 'hello', name: 'rafael')
+      assert_equal 'volmer', sub_sample.title
+      assert_equal 'hello', sub_sample.body
+      assert_equal 'rafael', sub_sample.name
+    end
+
+    test '#attributes returns the collection of attributes' do
+      sample = Sample.new(title: 'volmer', body: 'hello')
+
+      assert_equal({ title: 'volmer', body: 'hello' }, sample.attributes)
+    end
+  end
+end

data/test/upgrow/immutable_struct_test.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Upgrow
+  class ImmutableStructTest < ActiveSupport::TestCase
+    test '.new creates a new Struct class with the given members as keyword arguments' do
+      struct_class = ImmutableStruct.new(:user, :post)
+
+      struct = struct_class.new(user: 'volmer', post: 'hello')
+
+      assert_equal([:user, :post], struct.members)
+      assert_equal(['volmer', 'hello'], struct.values)
+      assert struct.frozen?
+    end
+
+    test '.new accepts symbols only' do
+      error = assert_raises(ArgumentError) do
+        ImmutableStruct.new('Shopify', :user, :post)
+      end
+
+      assert_equal 'all members must be symbols', error.message
+    end
+
+    test 'it does not respond to []=' do
+      struct = ImmutableStruct.new(:user).new(user: 'volmer')
+      refute struct.respond_to?(:[]=)
+    end
+
+    test 'it does not allow members to be mutated' do
+      struct_class = ImmutableStruct.new(:user, :post)
+
+      struct = struct_class.new(user: 'volmer', post: 'hello')
+
+      refute struct.respond_to?(:user=)
+      refute struct.respond_to?(:post=)
+    end
+
+    test '.new requires all members' do
+      struct_class = ImmutableStruct.new(:user, :post)
+
+      error = assert_raises(KeyError) do
+        struct_class.new(user: 'volmer')
+      end
+
+      assert_equal 'key not found: :post', error.message
+    end
+  end
+end

data/test/upgrow/input_test.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'action_controller/metal/strong_parameters'
+
+module Upgrow
+  class InputTest < ActiveSupport::TestCase
+    class SampleInput < Input
+      attribute :title
+      attribute :body
+
+      validates :title, presence: true
+    end
+
+    test '#errors is an empty Active Model Errors' do
+      input = Input.new
+      errors = input.errors
+      assert_empty errors
+    end
+
+    test '.new accepts individual arguments' do
+      input = SampleInput.new(title: 'volmer', body: 'hello')
+
+      assert_equal 'volmer', input.title
+      assert_equal 'hello', input.body
+    end
+
+    test '.new accepts a Hash of Symbols' do
+      args = { title: 'volmer', body: 'hello' }
+      input = SampleInput.new(args)
+
+      assert_equal 'volmer', input.title
+      assert_equal 'hello', input.body
+    end
+
+    test '.new accepts a Hash of Strings' do
+      args = { 'title' => 'volmer', 'body' => 'hello' }
+      input = SampleInput.new(args)
+
+      assert_equal 'volmer', input.title
+      assert_equal 'hello', input.body
+    end
+
+    test '.new accepts Action Controller parameters' do
+      args = ActionController::Parameters.new(
+        'title' => 'volmer', 'body' => 'hello'
+      ).permit(:title, :body)
+
+      input = SampleInput.new(args)
+
+      assert_equal 'volmer', input.title
+      assert_equal 'hello', input.body
+    end
+
+    test '.valid? is true when validation passes' do
+      input = SampleInput.new(title: 'volmer')
+      assert_predicate input, :valid?
+    end
+
+    test '.valid? is false when validation fails' do
+      input = SampleInput.new
+      refute_predicate input, :valid?
+    end
+  end
+end

data/test/upgrow/model_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Upgrow
+  class ModelTest < ActiveSupport::TestCase
+    class SampleModel < Model
+      attribute :title
+      attribute :body
+    end
+
+    test '.attribute_names includes :id, :created_at, and :updated_at' do
+      expected = [:id, :created_at, :updated_at, :title, :body]
+      assert_equal expected, SampleModel.attribute_names
+    end
+
+    test '.new requires all attributes' do
+      error = assert_raises(KeyError) do
+        SampleModel.new(
+          title: 'volmer', id: 1, created_at: Time.now, updated_at: Time.now
+        )
+      end
+
+      assert_equal 'key not found: :body', error.message
+    end
+  end
+end

data/test/upgrow/result_test.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Upgrow
+  class ResultTest < ActiveSupport::TestCase
+    setup do
+      @errors = [:error]
+    end
+
+    test '.new returns a Result class with the given members and errors' do
+      result_class = Result.new(:user)
+      assert_equal([:user, :errors], result_class.members)
+    end
+
+    test '.new returns a Result class with only errors when called without arguments' do
+      result_class = Result.new
+      assert_equal([:errors], result_class.members)
+    end
+
+    test '.success returns a Result populated with the given values' do
+      result = Result.new(:user).success(user: 'volmer')
+      assert_equal 'volmer', result.user
+      assert_empty result.errors
+    end
+
+    test '.failure returns a Result populated with the given errors' do
+      result = Result.new(:user).failure(@errors)
+      assert_nil result.user
+      assert_equal @errors, result.errors
+    end
+
+    test '#and_then calls the given block and returns self for a successful Result' do
+      called = false
+
+      success = Result.new.success
+
+      returned_value = success.and_then { called = true }
+
+      assert called
+      assert_same success, returned_value
+    end
+
+    test '#or_else passes the Result values as an argument to the given block' do
+      success = Result.new(:user, :post)
+        .success(user: 'volmer', post: 'hello!')
+
+      success.and_then do |user:, post:|
+        assert_equal 'volmer', user
+        assert_equal 'hello!', post
+      end
+    end
+
+    test '#and_then does not call the given block and returns self for a failure Result' do
+      called = false
+
+      failure = Result.new.failure(@errors)
+
+      returned_value = failure.and_then { called = true }
+
+      refute called
+      assert_same failure, returned_value
+    end
+
+    test '#or_else does not call the given block and returns self for a successful Result' do
+      called = false
+
+      success = Result.new.success
+
+      returned_value = success.or_else { called = true }
+
+      refute called
+      assert_same success, returned_value
+    end
+
+    test '#or_else calls the given block and returns self for a failure Result' do
+      called = false
+
+      failure = Result.new.failure(@errors)
+
+      returned_value = failure.or_else { called = true }
+
+      assert called
+      assert_same failure, returned_value
+    end
+
+    test '#or_else passes the errors as an argument to the given block' do
+      failure = Result.new.failure(@errors)
+
+      failure.or_else do |errors|
+        assert_equal @errors, errors
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: upgrow
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
-dependencies: []
+date: 2021-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: 
 email: gems@shopify.com
 executables: []
@@ -19,13 +33,71 @@ files:
 - README.md
 - Rakefile
 - lib/upgrow.rb
-- test/documentation_test.rb
+- lib/upgrow/action.rb
+- lib/upgrow/active_record_adapter.rb
+- lib/upgrow/basic_repository.rb
+- lib/upgrow/immutable_object.rb
+- lib/upgrow/immutable_struct.rb
+- lib/upgrow/input.rb
+- lib/upgrow/model.rb
+- lib/upgrow/repository.rb
+- lib/upgrow/result.rb
+- test/application_system_test_case.rb
+- test/dummy/app/actions/create_article_action.rb
+- test/dummy/app/actions/delete_article_action.rb
+- test/dummy/app/actions/edit_article_action.rb
+- test/dummy/app/actions/list_articles_action.rb
+- test/dummy/app/actions/show_article_action.rb
+- test/dummy/app/actions/update_article_action.rb
+- test/dummy/app/channels/application_cable/channel.rb
+- test/dummy/app/channels/application_cable/connection.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/articles_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/inputs/article_input.rb
+- test/dummy/app/jobs/application_job.rb
+- test/dummy/app/mailers/application_mailer.rb
+- test/dummy/app/models/article.rb
+- test/dummy/app/records/application_record.rb
+- test/dummy/app/records/article_record.rb
+- test/dummy/app/repositories/article_repository.rb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/application_controller_renderer.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/content_security_policy.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/permissions_policy.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/puma.rb
+- test/dummy/config/routes.rb
+- test/dummy/db/migrate/20210219211631_create_articles.rb
+- test/dummy/db/schema.rb
+- test/rails_helper.rb
+- test/system/articles_test.rb
 - test/test_helper.rb
+- test/upgrow/action_test.rb
+- test/upgrow/active_record_adapter_test.rb
+- test/upgrow/basic_repository_test.rb
+- test/upgrow/documentation_test.rb
+- test/upgrow/immutable_object_test.rb
+- test/upgrow/immutable_struct_test.rb
+- test/upgrow/input_test.rb
+- test/upgrow/model_test.rb
+- test/upgrow/result_test.rb
 homepage: https://github.com/Shopify/upgrow
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/upgrow/tree/v0.0.1
+  source_code_uri: https://github.com/Shopify/upgrow/tree/v0.0.2
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -45,7 +117,56 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Patterns for Rails Architecture
+summary: A sustainable architecture for Ruby on Rails.
 test_files:
+- test/dummy/db/migrate/20210219211631_create_articles.rb
+- test/dummy/db/schema.rb
+- test/dummy/app/mailers/application_mailer.rb
+- test/dummy/app/inputs/article_input.rb
+- test/dummy/app/controllers/articles_controller.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/jobs/application_job.rb
+- test/dummy/app/records/application_record.rb
+- test/dummy/app/records/article_record.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/actions/create_article_action.rb
+- test/dummy/app/actions/delete_article_action.rb
+- test/dummy/app/actions/update_article_action.rb
+- test/dummy/app/actions/list_articles_action.rb
+- test/dummy/app/actions/edit_article_action.rb
+- test/dummy/app/actions/show_article_action.rb
+- test/dummy/app/models/article.rb
+- test/dummy/app/channels/application_cable/channel.rb
+- test/dummy/app/channels/application_cable/connection.rb
+- test/dummy/app/repositories/article_repository.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/content_security_policy.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/application_controller_renderer.rb
+- test/dummy/config/initializers/permissions_policy.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/puma.rb
+- test/dummy/config/application.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environment.rb
+- test/rails_helper.rb
+- test/application_system_test_case.rb
+- test/system/articles_test.rb
+- test/upgrow/immutable_object_test.rb
+- test/upgrow/immutable_struct_test.rb
+- test/upgrow/result_test.rb
+- test/upgrow/basic_repository_test.rb
+- test/upgrow/action_test.rb
+- test/upgrow/documentation_test.rb
+- test/upgrow/model_test.rb
+- test/upgrow/input_test.rb
+- test/upgrow/active_record_adapter_test.rb
 - test/test_helper.rb
-- test/documentation_test.rb