ff-tbl-macros 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 134458580b82af72b8df814edfc9e0ad9a30ee388c3022e18d8cae0f2052176c
+  data.tar.gz: 7ac93a23b408fef75f9f9557cc848863280a8838d9e0adcbd707172f01600029
+SHA512:
+  metadata.gz: 45456aadf56e6642a389c708ef27157544fe2c2c576715e7a83662c52ace88928056e75aada6722b48a4ababded4bc7021bb3e3eb7ee51e9cd47008289def016
+  data.tar.gz: d6f546fb293f0df15bce02d573821438b773bb8e44dea1aeacdf83addadbcd7c7ec92c0dd5a4b601d9126987bc71a5b9cb0ef05acfad794cd433942a7f2ed57b

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:2.6.1-alpine3.9
+
+LABEL maintainer="devops@firefield.com"
+
+RUN apk add --no-cache --update build-base linux-headers
+RUN apk add --no-cache --update git file
+
+ENV APP_PATH /usr/src/app
+WORKDIR $APP_PATH
+
+COPY . .
+
+RUN bundle install --jobs `expr $(cat /proc/cpuinfo | grep -c "cpu cores") - 1` --retry 3

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'recursive-open-struct'
+  gem 'reform'
+  gem 'require_all'
+  gem 'rspec'
+  gem 'rspec-activemodel-mocks'
+  gem 'rubocop'
+  gem 'simplecov'
+  gem 'trailblazer'
+  gem 'warden'
+end

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    ff-tbl-macros (0.1.8)
+      activesupport (~> 5.2)
+      require_all (~> 2.0)
+      trailblazer (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.1.4)
+    declarative (0.0.10)
+    declarative-builder (0.1.0)
+      declarative-option (< 0.2.0)
+    declarative-option (0.1.0)
+    diff-lcs (1.3)
+    disposable (0.4.4)
+      declarative (>= 0.0.9, < 1.0.0)
+      declarative-builder (< 0.2.0)
+      declarative-option (< 0.2.0)
+      representable (>= 2.4.0, <= 3.1.0)
+      uber (< 0.2.0)
+    docile (1.3.1)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.2.0)
+      ast (~> 2.4.0)
+    pipetree (0.1.1)
+    psych (3.1.0)
+    rack (2.0.6)
+    rainbow (3.0.0)
+    recursive-open-struct (1.1.0)
+    reform (2.2.4)
+      disposable (>= 0.4.1)
+      representable (>= 2.4.0, < 3.1.0)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    require_all (2.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-activemodel-mocks (1.1.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      rspec-mocks (>= 2.99, < 4.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    trailblazer (2.0.7)
+      declarative
+      reform (>= 2.2.0, < 3.0.0)
+      trailblazer-operation (>= 0.0.12, < 0.1.0)
+    trailblazer-operation (0.0.13)
+      declarative
+      pipetree (>= 0.1.1, < 0.2.0)
+      uber
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uber (0.1.0)
+    unicode-display_width (1.5.0)
+    warden (1.2.8)
+      rack (>= 2.0.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ff-tbl-macros!
+  recursive-open-struct
+  reform
+  require_all
+  rspec
+  rspec-activemodel-mocks
+  rubocop
+  simplecov
+  trailblazer
+  warden
+
+BUNDLED WITH
+   1.17.3

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# ff-tbl-macros
+
+![MIT-LICENSE](https://img.shields.io/github/license/firefield/ff-tbl-macros.svg?style=flat-square) ![build status](https://img.shields.io/travis/firefield/ff-tbl-macros.svg?style=flat-square)
+
+Macros for Trailblazer operations.
+
+# Overview
+
+## Features
+
+- several predefined macros organized in namespaces
+- custom macros
+
+# Getting Started
+
+## Prerequisites
+
+For contributing, install docker to use the provided dockerized development environment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ff-tbl-macros', git: 'https://github.com/firefield/ff-tbl-macros.git'
+```
+
+# Usage
+
+Use the macros in the operation steps:
+
+```ruby
+class User::Delete < Trailblazer::Operation
+  step Macros::Model::Destroy()
+end
+```
+
+# Contributing
+
+1. Fork the Project
+1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
+1. Commit your Changes (git commit -m 'Add some AmazingFeature)
+1. Push to the Branch (git push origin feature/AmazingFeature)
+1. Open a Pull Request
+
+## Development
+
+The project includes a dockerized development environment.
+
+```
+# build the docker containers
+docker-compose build
+
+# run the specs
+docker-compose run --rm app bundle exec rspec
+
+```
+
+# Documentation
+
+## Macros Types
+
+There are several types of macros organized in namespaces.
+
+### Auth Macros
+
+- `Macros::Auth::Authenticate`
+- `Macros::Auth::SignIn`
+- `Macros::Auth::SignOut`
+
+### Contract Macros
+
+- `Macros::Contract::ExtractParams`
+- `Macros::Contract::Prepopulate`
+
+### Context Macros
+
+- `Macros::Ctx::Copy`
+- `Macros::Ctx::Inspect`
+- `Macros::Ctx::ValidatePresence`
+
+### Current User Macros
+
+- `Macros::CurrentUser::Set`
+
+### Error Macros
+
+- `Macros::Error::SetFromContract`
+
+### Model Macros
+
+- `Macros::Model::Build`
+- `Macros::Model::Copy`
+- `Macros::Model::Destroy`
+- `Macros::Model::Persist`
+
+### Search Macros
+
+- `Macros::Search::Query`
+
+### Verify Params Macros
+
+- `Macros::VeriryParams::Date`
+
+## Application Specific Macros
+
+You can create your own custom macros specific to your application. Just put them in the _lib/macros_ folder of your Rails app following this convention:
+
+_lib/macros/lorem.rb_
+```ruby
+module Macros
+  class Lorem < Macros::Base
+    register :print_ipsum
+  end
+end
+```
+
+_lib/macros/lorem/print_ipsum.rb_
+```ruby
+module Macros
+  class Lorem
+    # Some info what your macro does
+    #
+    # @examples
+    #   step Macros::Lorem::PrintIpsum(count:)
+    #
+    class PrintIpsum < Macros::Base
+      def initialize(count:)
+        @count = count
+      end
+
+      def call(ctx, **)
+        @count.times { print 'Ipsum' }
+      end
+    end
+  end
+end
+```
+
+# License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+# Aknowledgements
+
+Gem used https://github.com/coditsu/macros as the base.
+

data/lib/ff-tbl-macros.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+%w[
+  trailblazer
+  require_all
+  active_support/inflector
+  uber/options
+].each { |lib| require lib }
+
+# Trailblazer shared macros used across multiple apps
+module Macros
+  class << self
+    # @return [String] root path to this gem
+    # @example
+    #   Macros.gem_root #=> '/home/user/.gems/macros'
+    def gem_root
+      File.expand_path('..', __dir__)
+    end
+  end
+end
+
+require File.dirname(__FILE__) + '/macros/base.rb' # Macros::Base must be loaded before other macros' classes
+require_all File.dirname(__FILE__) + '/**/*.rb' # load gem' macros
+
+# load app specific macros
+if Dir.exist? 'lib/macros'
+  require_all 'lib/macros/*.rb'
+  require_all 'lib/macros/**/*.rb'
+end

data/lib/macros/auth.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Macros
+  class Auth < Macros::Base
+    register :authenticate
+    register :sign_in
+    register :sign_out
+  end
+end

data/lib/macros/auth/authenticate.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Macros
+  class Auth
+    # Authenticates the given user using warden. This code run at the rack level, and is tied to the request.
+    #
+    class Authenticate < Base
+      # @return [Macro::Auth::SignIn] step macro instance
+      def initialize; end
+
+      # Performs a step by authenticating the the given user
+      # @param ctx [Trailblazer::Skill] tbl context hash
+      def call(ctx, scope:, warden:, **)
+        user = warden.authenticate(scope: scope)
+        if user
+          ctx[:model] = user
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/macros/auth/sign_in.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Macros
+  class Auth
+    # Sign in the given user. The user is passed in ctx[:model].
+    #
+    class SignIn < Macros::Base
+      # @return [Macro::Auth::SignIn] step macro instance
+      def initialize(condition: nil)
+        @condition = condition
+      end
+
+      # Performs a step by signing in the given user
+      # @param ctx [Trailblazer::Skill] tbl context hash
+      def call(ctx, model:, warden:, **)
+        return false if @condition && ctx[@condition].blank?
+
+        options = ctx[:sign_in_options] || {}
+        scope = Devise::Mapping.find_scope!(model)
+        expire_data_after_sign_in(session: warden.session_serializer.session)
+
+        if warden.user(scope) == model && !options.delete(:force)
+          # Do nothing. User already signed in and we are not forcing it.
+          true
+        else
+          options[:scope] = scope
+          warden.set_user(model, options)
+        end
+
+        ctx[:current_user] = model
+        true
+      end
+
+      def expire_data_after_sign_in(session:)
+        # session.keys will return an empty array if the session is not yet loaded.
+        # This is a bug in both Rack and Rails.
+        # A call to #empty? forces the session to be loaded.
+        session.empty?
+        session.keys.grep(/^devise\./).each { |k| session.delete(k) }
+      end
+    end
+  end
+end

data/lib/macros/auth/sign_out.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Macros
+  class Auth
+    # Signout the given user. The user can be passed in the context.
+    #
+    # @example signout a user specified in the context (:scope or :model)
+    #   step Macros::Auth::SignOut()
+    #
+    # @example signout the user passed in ctx[:impersonated_user]
+    #   step Macros::Auth::SignOut(user_key: :impersonated_user)
+    class SignOut < Macros::Base
+      # @return [Macro::Auth::SignOut] step macro instance
+      # @param user_key [Hash] ctx key under which is the user which we want to signout
+      def initialize(user_key: nil)
+        @user_key = user_key
+        @user = nil
+      end
+
+      # Performs a step by signout the given user
+      # @param ctx [Trailblazer::Skill] tbl context hash
+      def call(ctx, warden:, **)
+        @user = ctx[@user_key] if @user_key
+
+        ctx[:scope] = scope(ctx)
+        warden_user = warden.user(scope: ctx[:scope], run_callbacks: false)
+        ctx[:model] = warden_user unless @user
+        warden.logout(ctx[:scope])
+        warden.clear_strategies_cache!(scope: ctx[:scope])
+        true
+      end
+
+      def scope(ctx)
+        resource_or_scope = if @user
+                              @user
+                            elsif ctx[:scope]
+                              ctx[:scope]
+                            elsif ctx[:model]
+                              ctx[:model]
+                            else
+                              :user
+                            end
+
+        Devise::Mapping.find_scope!(resource_or_scope)
+      end
+    end
+  end
+end