carbonyte 0.1.0 → 0.2.0

data/spec/dummy/db/schema.rb

@@ -0,0 +1,21 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `rails
+# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 2020_10_07_132857) do
+
+  create_table "users", force: :cascade do |t|
+    t.string "email", null: false
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+  end
+
+end

data/spec/interactors/application_interactor_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+RSpec.describe Carbonyte::ApplicationInteractor do
+  class TestInteractor < Carbonyte::ApplicationInteractor
+    def call
+      context.this_should_be_me = context.current_interactor
+    end
+  end
+
+  let(:interactor) { TestInteractor.new }
+
+  it 'sets the current_interactor in context before #call' do
+    interactor.run
+    res = interactor.context
+    expect(res.this_should_be_me).to eq(interactor)
+  end
+
+  it 'resets the current_interactor in context to nil after #call' do
+    interactor.run
+    res = interactor.context
+    expect(res.current_interactor).to be_nil
+  end
+end

data/spec/interactors/finders/application_finder_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+RSpec.describe Carbonyte::Finders::ApplicationFinder do
+  class TestFinder < Carbonyte::Finders::ApplicationFinder
+    ALLOWED_INCLUDES = %i[field1 field2].freeze
+
+    def can_include?(rel)
+      ALLOWED_INCLUDES.include?(rel)
+    end
+  end
+
+  let(:params) { {} }
+  let(:scope) { double }
+  let(:finder) { TestFinder.new(scope: scope, params: params) }
+
+  before do
+    allow(scope).to receive(:limit).and_return(scope)
+    allow(scope).to receive(:page).and_return(scope)
+  end
+
+  it 'does not include any relation by default' do
+    expect(described_class.new.can_include?(:any)).to be_falsey
+  end
+
+  it 'automatically paginates the result with default values' do
+    expect(scope).to receive(:limit).with(25).and_return(scope)
+    expect(scope).to receive(:page).with(1).and_return(scope)
+    finder.run
+  end
+
+  context 'with include param' do
+    let(:params) { { include: 'field1,field2' } }
+
+    it 'automatically includes relations' do
+      expect(scope).to receive(:includes).with(:field1).and_return(scope)
+      expect(scope).to receive(:includes).with(:field2).and_return(scope)
+      finder.run
+    end
+  end
+
+  context 'with sort param' do
+    let(:params) { { sort: 'field1,-field2' } }
+
+    it 'automatically sorts the result' do
+      expect(scope).to receive(:order).with(:field1).and_return(scope)
+      expect(scope).to receive(:order).with({ field2: :desc }).and_return(scope)
+      finder.run
+    end
+  end
+
+  context 'with page and limit params' do
+    let(:params) { { limit: 10, page: 10 } }
+
+    it 'paginates the result based on settings' do
+      expect(scope).to receive(:limit).with(10).and_return(scope)
+      expect(scope).to receive(:page).with(10).and_return(scope)
+      finder.run
+    end
+  end
+end

data/spec/policies/application_policy_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe Carbonyte::ApplicationPolicy do
+  class TestPolicy < Carbonyte::ApplicationPolicy; end
+
+  let(:policy) { TestPolicy.new(nil, nil) }
+  let(:policy_scope) { TestPolicy::Scope.new(nil, double(all: [])) }
+
+  it 'allows all default actions by default' do
+    expect(policy.index?).to be_truthy
+    expect(policy.show?).to be_truthy
+    expect(policy.create?).to be_truthy
+    expect(policy.update?).to be_truthy
+    expect(policy.destroy?).to be_truthy
+  end
+
+  it 'provides a default scope by default' do
+    expect(policy_scope.resolve).to eq([])
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+require 'support/carbonyte/spec_helper'
+
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].sort.each { |f| require f }
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, type: :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/spec/spec_helper.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start do
+  minimum_coverage 90
+  minimum_coverage_by_file 85
+end
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  # config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  # config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  #   # Use the documentation formatter for detailed output,
+  #   # unless a formatter has already been configured
+  #   # (e.g. via a command-line flag).
+  #   config.default_formatter = 'doc'
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  # Kernel.srand config.seed
+end

data/spec/support/carbonyte/api_helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ApiHelpers
+  def parsed_response
+    JSON.parse(response.body)
+  end
+end
+
+RSpec.configure do |config|
+  %i[request controller].each do |type|
+    config.include ApiHelpers, type: type
+  end
+end

data/spec/support/carbonyte/spec_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path('../../dummy/config/environment', __dir__)
+# Prevent database truncation if the environment is production
+abort('The Rails environment is running in production mode!') if Rails.env.production?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carbonyte
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - iMacTia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interactor-rails
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: logstash-event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: pundit
   requirement: !ruby/object:Gem::Requirement
@@ -73,33 +101,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.0.3.2
 - !ruby/object:Gem::Dependency
-  name: inch
+  name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
+        version: '1.5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.5'
 description: Carbonyte is the core of great Microservices-oriented Architectures.
 email:
 - giuffrida.mattia@gmail.com
@@ -110,36 +124,80 @@ files:
 - README.md
 - Rakefile
 - app/controllers/carbonyte/application_controller.rb
+- app/controllers/carbonyte/concerns/correlatable.rb
+- app/controllers/carbonyte/concerns/loggable.rb
+- app/controllers/carbonyte/concerns/policiable.rb
 - app/controllers/carbonyte/concerns/rescuable.rb
+- app/controllers/carbonyte/concerns/serializable.rb
 - app/interactors/carbonyte/application_interactor.rb
 - app/interactors/carbonyte/finders/application_finder.rb
 - app/models/carbonyte/application_record.rb
+- app/policies/carbonyte/application_policy.rb
 - app/serializers/carbonyte/application_serializer.rb
 - config/routes.rb
 - lib/carbonyte.rb
 - lib/carbonyte/engine.rb
+- lib/carbonyte/initializers.rb
+- lib/carbonyte/initializers/lograge.rb
 - lib/carbonyte/version.rb
 - lib/tasks/carbonyte_tasks.rake
+- spec/api/health_spec.rb
+- spec/controllers/concerns/rescuable_spec.rb
+- spec/controllers/concerns/serializable_spec.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/spring.rb
+- spec/dummy/config/storage.yml
+- spec/dummy/db/migrate/20201007132857_create_users.rb
+- spec/dummy/db/schema.rb
+- spec/interactors/application_interactor_spec.rb
+- spec/interactors/finders/application_finder_spec.rb
+- spec/policies/application_policy_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/support/carbonyte/api_helpers.rb
+- spec/support/carbonyte/spec_helper.rb
 homepage: https://github.com/iMacTia/carbonyte
 licenses:
-- Copyright
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
+- spec/support
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Build Microservices-oriented Architectures with ease