superlime 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc812e30e0e32bfedeae06f12f53fcf3c76ee61deaf1df87bf5a47236ec29b86
+  data.tar.gz: 966de652036a5b8be1e42a7405ada5f9d43272541f836325cb626ba46d593bff
+SHA512:
+  metadata.gz: 870f31129f15de7dcf97a77ac9adbd6dfb5081f538d277628305799dc234ba5cba21f29a54da797a26745520d0fd11b8e8e2192e6326e00bc97a91219676efd6
+  data.tar.gz: 968fef5cdde05593ec65e5a135c60a797e74bc132454091449a5910167810785d445ae06577184bb5622e622a34abcf7e9bc0a7e45d4989e0ee3f16076dacdb2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in superlime.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    superlime (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.0)
+    rake (13.0.1)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  superlime!
+
+BUNDLED WITH
+   2.2.0.rc.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Lee Machin
+
+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,68 @@
+# Superlime
+
+A replacement for [Rectify::Command](https://github.com/andypike/rectify#commands) that uses Ruby 2.7 pattern matching in place of events.
+Uses a mostly-compatible API.
+
+## Usage
+
+When creating a command, have it inherit from `Superlime::Command` (instead of `Rectify::Command` if refactoring).
+
+```ruby
+class Payment::Send < Superlime::Command
+  attr_reader :params
+  
+  def initialize(params)
+    @params = params
+  end
+
+  def call
+    broadcast(:no_payee) if params[:payee].nil?
+    transaction = make_payment!
+    broadcast(:success, tx_id: transaction.id)
+  rescue PaymentError, SomeSillyError => err
+    broadcast(:error, err)    
+  end
+  
+  private 
+
+  def make_payment!
+    # do the payment...
+    # raise if payment_failed 
+  end 
+end
+```
+
+The behaviour is mostly the same, except you don't require a `return` invocation when calling `broadcast`.
+
+In order to use this command, you can use Ruby's brand new pattern matching niceness. It's a little bit different but
+offers a lot of flexibility depending on the complexity of your command.
+
+```ruby
+class PaymentController < ApplicationController
+  def create
+    case Payment::Send.call(payment_params)
+    in success: result then render json: result
+    in :no_payee then head :bad_request
+    in error: PaymentError => err then render json: err.message, status: :internal_server_error
+    in error: SomeSillyError then redirect_to 'http://www.zombo.com'
+    end
+  end
+
+  private
+
+  def payment_params
+    params.require(:payment).permit(:payee, :card_details_and_stuff)
+  end
+end
+```
+
+Ruby's pattern matching allows you to match against types, hashes, arrays, while also being able to destructure them,
+so these destructurings can be as simple or complex as you like (including destructuring of custom classes).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrleedev/superlime.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/azure-pipelines.yml

@@ -0,0 +1,23 @@
+# Ruby
+# Package your Ruby project.
+# Add steps that install rails, analyze code, save build artifacts, deploy, and more:
+# https://docs.microsoft.com/azure/devops/pipelines/languages/ruby
+
+trigger:
+- master
+
+pool:
+  vmImage: 'ubuntu-latest'
+
+steps:
+- task: UseRubyVersion@0
+  inputs:
+    versionSpec: '>= 2.5'
+
+- script: |
+    gem install bundler
+    bundle install --retry=3 --jobs=4
+  displayName: 'bundle install'
+
+- script: bundle exec rake
+  displayName: 'bundle exec rake'

data/bin/console

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "superlime"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/superlime.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'superlime/version'
+require 'superlime/command'
+
+module Superlime
+end

data/lib/superlime/command.rb

@@ -0,0 +1,23 @@
+module Superlime
+  class Command
+    def self.call(args)
+      catch(:broadcast) do
+        new(args).call
+      end
+    end
+
+    def initialize(*args)
+      raise NotImplementedError, "must implement #initialize on subclass"
+    end
+
+    def call
+      raise NotImplementedError, "must implement #call on subclass"
+    end
+
+    private
+
+    def broadcast(event, payload)
+      throw(:broadcast, event => payload)
+    end
+  end
+end

data/lib/superlime/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Superlime
+  VERSION = "0.1.0"
+end

data/superlime.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/superlime/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "superlime"
+  spec.version       = Superlime::VERSION
+  spec.authors       = ["Lee Machin"]
+  spec.email         = ["me@mrlee.dev"]
+
+  spec.summary       = "Pattern-based controller commands"
+  spec.homepage      = "https://github.com/mrleedev/superlime"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mrleedev/superlime"
+  spec.metadata["changelog_uri"] = "https://github.com/mrleedev/superlime"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: superlime
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lee Machin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-06 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- me@mrlee.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- azure-pipelines.yml
+- bin/console
+- bin/setup
+- lib/superlime.rb
+- lib/superlime/command.rb
+- lib/superlime/version.rb
+- superlime.gemspec
+homepage: https://github.com/mrleedev/superlime
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mrleedev/superlime
+  source_code_uri: https://github.com/mrleedev/superlime
+  changelog_uri: https://github.com/mrleedev/superlime
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Pattern-based controller commands
+test_files: []