fast_cqrs 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6fbd421c52ee2e12bb6f6f8ed91ed982f677f9822fd0b2a2d96b6a69b4a717
-  data.tar.gz: c2b5f5f80607433188e269c1ed320d7860c1b23484ae469627e888a20446cfbf
+  metadata.gz: 194793fceace66ffc0629475aca67047c69c977ef3d9d6e45561f73056a0cd7d
+  data.tar.gz: 6fced80ae64e1773f68e5f5ecab6860e8d6261a96275a6349231283f47f8a36a
 SHA512:
-  metadata.gz: 0b7fb848f60d6e8f11147055edba61ce01978c5f928e6a36117ee9bdf0c2ff32436b11e728b2163b68b21fa2f6a8fcd02a1aefa135baed7ce34060b788b9ed12
-  data.tar.gz: 629e11ff7d505a9ff058d202e53a940e19b691fcdbce284aed585bd36f18fa4f15e89549b49c051fbadb939c469d214ba44792315c72f450d60c9ded0aac998c
+  metadata.gz: 8a68d3416791afaf06bd67b0568ff977df9b36177f7d039759cab05b24ec2cda12b5294945bc99e9a800f38d1086c57a808cf779d68df98e9899fb9c97bbb281
+  data.tar.gz: 5f10db1d6d3ecfd85b98cf31512509072436ff3527367a9d2d62870bc21dc6e822d9c400f2c274fc710ddf3e76c209a48fa89f3992d3c176d2002c2e8f7e4424

data/.github/workflows/gem-push.yml

@@ -1,10 +1,8 @@
-name: Ruby Gem
+name: Test & Release
 
 on:
   push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+    branches: [ release ]
 
 jobs:
   build:
@@ -17,22 +15,12 @@ jobs:
       uses: actions/setup-ruby@v1
       with:
         version: 2.7.x
+    - name: Install dependencies
+      run: bundle install
+    - name: Rubocop lint check
+      run: bundle exec rubocop
     - name: Run tests
-      run: |
-        bundle install
-        bundle exec rspec
-    # - name: Publish to GPR
-    #   run: |
-    #     mkdir -p $HOME/.gem
-    #     touch $HOME/.gem/credentials
-    #     chmod 0600 $HOME/.gem/credentials
-    #     printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-    #     gem build *.gemspec
-    #     gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-    #   env:
-    #     GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
-    #     OWNER: driggl
-
+      run: bundle exec rspec
     - name: Publish to RubyGems
       run: |
         mkdir -p $HOME/.gem

data/.github/workflows/gem-test.yml

@@ -0,0 +1,25 @@
+name: Run tests
+
+on:
+  push:
+    branches-ignore: [ release ]
+  pull_request:
+    branches: [ master release ]
+
+jobs:
+  build:
+    name: Build + Test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7.1
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.7.x
+    - name: Install dependencies
+      run: bundle install
+    - name: Rubocop lint check
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rspec

data/.rubocop.yml

@@ -0,0 +1,46 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.7.1
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+# Commonly used screens these days easily fit more than 80 characters.
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'fast_cqrs.gemspec'
+
+Style/DoubleNegation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fast_cqrs.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fast_cqrs (0.1.1)
+    fast_cqrs (0.2.0)
       dry-matcher
       dry-monads
       dry-struct
@@ -11,21 +11,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.6)
+    ast (2.4.0)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.3)
-    dry-configurable (0.11.5)
+    dry-configurable (0.11.6)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
       dry-equalizer (~> 0.2)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.4.10)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-initializer (3.0.3)
-    dry-logic (1.0.6)
+    dry-initializer (3.0.4)
+    dry-logic (1.0.8)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
@@ -35,7 +36,7 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.4)
       dry-equalizer
-    dry-schema (1.5.1)
+    dry-schema (1.5.6)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
@@ -55,15 +56,21 @@ GEM
       dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.5.0)
+    dry-validation (1.5.6)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
-      dry-schema (~> 1.5)
+      dry-schema (~> 1.5, >= 1.5.2)
     ice_nine (0.11.2)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -77,6 +84,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -85,6 +107,8 @@ DEPENDENCIES
   fast_cqrs!
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
+  rubocop-performance
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,4 +1,6 @@
-![Ruby Gem](https://github.com/driggl/fast_cqrs/workflows/Ruby%20Gem/badge.svg?branch=master)
+![Run tests](https://github.com/driggl/fast_cqrs/workflows/Run%20tests/badge.svg?branch=master&event=push)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ba5ae197b61f418ba9c4fdb0239aa8f4)](https://app.codacy.com/gh/driggl/fast_cqrs?utm_source=github.com&utm_medium=referral&utm_content=driggl/fast_cqrs&utm_campaign=Badge_Grade_Dashboard)
+[![Gem Version](https://badge.fury.io/rb/fast_cqrs.svg)](https://badge.fury.io/rb/fast_cqrs)
 
 # FastCqrs
 
@@ -97,6 +99,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/driggl/fast_cqrs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/driggl/fast_cqrs/blob/master/CODE_OF_CONDUCT.md).
 
+### Publishing new version
+
+1. Push commit with updated `version.rb` file to the `release` branch. The new version will be automatically pushed to [rubygems](https://rubygems.org).
+2. Create release on github including change log.
 
 ## License
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "fast_cqrs"
+require 'bundler/setup'
+require 'fast_cqrs'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "fast_cqrs"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/fast_cqrs.gemspec

@@ -1,35 +1,40 @@
+# frozen_string_literal: true
+
 require_relative 'lib/fast_cqrs/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fast_cqrs"
+  spec.name          = 'fast_cqrs'
   spec.version       = FastCqrs::VERSION
-  spec.authors       = ["Sebastian Wilgosz"]
-  spec.email         = ["sebastian@driggl.com"]
+  spec.authors       = ['Sebastian Wilgosz']
+  spec.email         = ['sebastian@driggl.com']
 
-  spec.summary       = %q{A lightweight CQRS scaffold for ruby-based web applications.}
-  spec.description   = %q{Write CQRS applications easily using functional endpoints without a hassle.}
-  spec.homepage      = "https://github.com/driggl/fast_cqrs"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'A lightweight CQRS scaffold for ruby-based web applications.'
+  spec.description   = 'Write CQRS applications easily using functional endpoints without a hassle.'
+  spec.homepage      = 'https://github.com/driggl/fast_cqrs'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/driggl/fast_cqrs"
-  spec.metadata["changelog_uri"] = "https://github.com/driggl/fast_cqrs/releases"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/driggl/fast_cqrs'
+  spec.metadata['changelog_uri'] = 'https://github.com/driggl/fast_cqrs/releases'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'dry-matcher'
   spec.add_dependency 'dry-monads'
   spec.add_dependency 'dry-struct'
   spec.add_dependency 'dry-types'
   spec.add_dependency 'dry-validation'
+
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
 end

data/lib/fast_cqrs.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'fast_cqrs/version'
 require 'fast_cqrs/authorizer'
 require 'fast_cqrs/request'
 require 'fast_cqrs/transaction'
+require 'fast_cqrs/query'
 
 module FastCqrs
   class Error < StandardError; end

data/lib/fast_cqrs/authorizer.rb

@@ -3,6 +3,10 @@
 require 'dry/monads'
 
 module FastCqrs
+  # A base Authorizer class used to validate the access to the given resource
+  # an easy to use hash.
+  # Usage: Inherit and override the #authorize method
+  #
   class Authorizer
     def self.inherited(klass)
       super
@@ -11,16 +15,17 @@ module FastCqrs
       end
     end
 
-    def call(**)
-      return Success() if authorize
+    def call(subject: nil, auth: nil)
+      return Success() if authorize(subject, auth)
+
       fail!
     end
 
     protected
 
     # Override this in the inherited class
-    def authorize
-      true
+    def authorize(_subject, _auth)
+      false
     end
 
     private

data/lib/fast_cqrs/deserializer/json_api.rb

@@ -4,6 +4,10 @@ require 'ostruct'
 
 module FastCqrs
   module Deserializer
+    # Transforms the JSON API request body to a flat hash
+    # Input: { data: { id: 1, type: 'foo', attributes: { bar: 'bar' } } }
+    # Output: { id: 1, resource_type: 'foo', bar: 'bar' }
+    #
     class JsonApi
       IncorrectFormat = Class.new(StandardError)
       HashInputRequired = Class.new(StandardError)
@@ -28,4 +32,4 @@ module FastCqrs
       end
     end
   end
-end
+end

data/lib/fast_cqrs/query.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'dry/matcher/result_matcher'
+require 'dry/monads'
+require 'dry/validation'
+
+module FastCqrs
+  # A base transaction class to process the request.
+  # Usage: Inherit and override the #call
+  #
+  class Query
+    Dry::Validation.load_extensions(:monads)
+    def self.inherited(klass)
+      super
+      klass.class_eval do
+        include Dry::Monads[:do, :result, :try]
+        include Dry::Matcher.for(:call, with: Dry::Matcher::ResultMatcher)
+      end
+    end
+
+    def call(_input, _auth: nil)
+      Success()
+    end
+  end
+end

data/lib/fast_cqrs/request.rb

@@ -3,6 +3,11 @@
 require 'dry/monads'
 
 module FastCqrs
+  # A base Request class uses deserializer to parse the Rack::Request body into
+  # an easy to use hash. Useful when more data are required
+  # than passed in the input
+  # Usage: Inherit and override the #model method
+  #
   class Request
     include Dry::Monads[:result, :try]
 

data/lib/fast_cqrs/transaction.rb

@@ -5,6 +5,9 @@ require 'dry/monads'
 require 'dry/validation'
 
 module FastCqrs
+  # A base transaction class to process the request.
+  # Usage: Inherit and override the #call
+  #
   class Transaction
     Dry::Validation.load_extensions(:monads)
     def self.inherited(klass)
@@ -15,7 +18,7 @@ module FastCqrs
       end
     end
 
-    def call(input, **)
+    def call(_input, _auth: nil)
       Success()
     end
   end

data/lib/fast_cqrs/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FastCqrs
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_cqrs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-matcher
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Write CQRS applications easily using functional endpoints without a hassle.
 email:
 - sebastian@driggl.com
@@ -88,8 +116,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/gem-push.yml"
+- ".github/workflows/gem-test.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -105,6 +135,7 @@ files:
 - lib/fast_cqrs.rb
 - lib/fast_cqrs/authorizer.rb
 - lib/fast_cqrs/deserializer/json_api.rb
+- lib/fast_cqrs/query.rb
 - lib/fast_cqrs/request.rb
 - lib/fast_cqrs/transaction.rb
 - lib/fast_cqrs/version.rb
@@ -131,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A lightweight CQRS scaffold for ruby-based web applications.