simpler_command 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 667240bb9109486b654cb65b71cec68f795d260883567c696e8fef2051dfe8f0
-  data.tar.gz: 58899bb01b7775769a386432010de4044120a8b2ee2e6c84f5cff55783c2083a
+  metadata.gz: c3e58436c2fc52ade4f02eaa5b14e3f733b18862e362c3d1d63091b094e5646d
+  data.tar.gz: 8b86650fc4e3c88bd91ab2e2a4dafcef03ac3e20dc97eb7c90fd3da1f1426579
 SHA512:
-  metadata.gz: a6561d0f75b6dbcde6a8246c32d5943f29fcd988eb81760c29d00f6f190b5ba121a371af2f75d2d3b6ff3b2d86d721aa9e2152694f105ab76a690d8b19251153
-  data.tar.gz: 566d35c4e9c1bea2ace1f2f9f1cf9d47693013005ea4956143da4d424498a99e6a9a51d31fadf9976dc48b5cdff848e73e206285e03080bf93a11f31cea52b0c
+  metadata.gz: b7f3da130c71e7836afc642f2a675fc8eede194484e09fac52d3121b901bc93d16b70bd919c84cdfef326140ff23fa6b22befda1fdd2d65baf7d747875bf6f8c
+  data.tar.gz: 65516b45e517f4abfc25bcb5f8ede605c201ae29a7f75d8c7ee03fcbf9ba823780c2b862e5ca17cd48fb3a4b9cf4b54a2d20e6c19194ce1a5f34d9bb8e6ed0d1

data/.github/workflows/ruby.yml

@@ -0,0 +1,39 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake
+    - name: Run tests with ActiveSupport
+      env:
+       ACTIVE_SUPPORT_ENABLED: 1
+      run: bundle exec rake
+    - name: Run Code Quality Metrics
+      run: bundle exec rubocop

data/CHANGELOG.md

@@ -4,8 +4,19 @@
 
 ### Added
 
-- Initial commit
-
 ### Changed
 
 ### Removed
+
+## [0.1.1] - 2020-09-14
+
+### Added
+
+- Added simpler_command generator for Rails Applications
+- Added rspec:simpler_command generator for testing SimplerCommand in Rails
+
+## [0.1.0] - 2020-09-11
+
+### Added
+
+- Initial commit

data/README.md

@@ -67,6 +67,16 @@ class Albums::UpdateDescriptionController < ApplicationController
 end
 ```
 
+### Rails generator
+
+For any Rails application, the easiest way to get started is by using the simpler_command generator.
+
+```bash
+bundle exec rails generator simpler_command AddSubscriptionToUser user subscription
+```
+
+This will generate the basic structure of your command inside the `app/commands` directory.
+
 ### The result object
 
 Commands are Service Objects, built with the intent of following the principles of Command-query separation: every method should either be a command that performs an action, or a query that returns data to the caller, but not both.

data/lib/generators/rspec/simpler_command/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Generates a spec for a Command (aka Service Object).
+
+    Provide additional command arguments for parameters used by the Command
+
+Example:
+    rails generate rspec:simpler_command PublishArticle article
+
+    This will create:
+        spec/commands/publish_article_spec.rb

data/lib/generators/rspec/simpler_command/simpler_command_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "generators/rspec"
+
+module Rspec
+  module Generators
+    # Rspec SimplerCommand Generator.
+    #
+    # Generates a spec for a command using SimplerCommand.
+    #
+    # Provide arguments to assist with boilerplate generation of your commands.
+    #
+    # == Examples
+    #
+    #    rails generator rspec:simpler_command EnableMaintainance
+    #    # => spec/commands/enable_maintainance_spec.rb
+    #    rails generator rspec:simpler_command PublishArticle article
+    #    # => spec/commands/publish_article_spec.rb
+    class SimplerCommand < Base
+      source_root File.expand_path("templates", __dir__)
+
+      argument :arguments, type: :array, default: [], banner: "command arguments"
+
+      def add_command_spec
+        template "command_spec.rb.erb", "spec/commands/#{file_name}_spec.rb"
+      end
+
+      private
+
+      def argument_parameters
+        arguments.map(&:parameterize)
+      end
+
+      def method_call(call_name, parameters)
+        [
+          call_name,
+          parameters.any? ? "(" : "",
+          parameters.join(", "),
+          parameters.any? ? ")" : ""
+        ].join
+      end
+    end
+  end
+end

data/lib/generators/rspec/simpler_command/templates/command_spec.rb.erb

@@ -0,0 +1,36 @@
+require "rails_helper"
+
+RSpec.describe <%= class_name %> do
+  describe ".call" do
+    subject(:response) { described_class.<%= method_call("call", argument_parameters) %> }
+
+    context "with valid parameters" do
+      # TODO: setup valid parameters
+      <%- argument_parameters.each do |arg| -%>
+      let(:<%= arg %>) { instance_double(<%= arg.classify %>) }
+      <%- end -%>
+
+      it { is_expected.to be_success }
+      it { expect(response.result).to be_nil }
+      <%- argument_parameters.each do |arg| -%>
+
+      it "interacts with <%= arg %>" do
+        pending "add expectations for interacting with <%= arg %>"
+
+        response
+
+        expect(<%= arg %>).to have_received(:example)
+      end
+      <%- end -%>
+    end
+
+    context "with invalid parameters" do
+      # TODO: setup invalid parameters
+      <%- argument_parameters.each do |arg| -%>
+      let(:<%= arg %>) { instance_double(<%= arg.classify %>) }
+      <%- end -%>
+
+      it { is_expected.to be_failure }
+    end
+  end
+end

data/lib/generators/simpler_command/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Generates a Command (aka Service Object) using SimplerCommand.
+
+    Provide additional command arguments for parameters used by the Command
+
+Example:
+    rails generate simpler_command PublishArticle article
+
+    This will create:
+        app/commands/publish_article.rb
+        spec/commands/publish_article_spec.rb

data/lib/generators/simpler_command/simpler_command_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# SimplerCommand Generator.
+#
+# Generates a command using SimplerCommand.
+#
+# Provide arguments to assist with boilerplate generation of your commands.
+#
+# == Examples
+#
+#    rails generator simpler_command EnableMaintainance # => app/commands/enable_maintainance.rb
+#    rails generator simpler_command PublishArticle article # => app/commands/publish_article.rb
+class SimplerCommandGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  argument :arguments, type: :array, default: [], banner: "command arguments"
+
+  def add_command_template
+    template "command.rb.erb", "app/commands/#{file_name}.rb"
+  end
+
+  hook_for :test_framework
+
+  private
+
+  def argument_parameters
+    arguments.map(&:parameterize)
+  end
+
+  def method_call(call_name, parameters)
+    parameters ||= []
+    [call_name, parameters.any? ? "(" : "", parameters.join(", "), parameters.any? ? ")" : ""].join
+  end
+end

data/lib/generators/simpler_command/templates/command.rb.erb

@@ -0,0 +1,41 @@
+# <%= class_name %> command.
+#
+# === Examples
+#
+#   <%= class_name %>.<%= method_call "call", argument_parameters %> # => response object with success? and result, or failure?
+#   <%= class_name %>.<%= method_call "call!", argument_parameters %> # => result, or thrown SimpleCommand::Failure
+class <%= class_name %>
+  # put SimplerCommand before the class' ancestors chain
+  prepend SimplerCommand
+
+  # Uncomment for Rails I18n Error Translations
+  # include ActiveModel::Validations
+
+  def <%= method_call "initialize", argument_parameters %>
+  <%- argument_parameters.each do |arg| -%>
+    @<%= arg %> = <%= arg %>
+  <%- end -%>
+  end
+
+  def call
+    # TODO: Implement <%= class_name %> command<%- if arguments.any? -%>, e.g. <% end %>
+    <%- if arguments.any? -%>
+    # unless [<%= argument_parameters.join(", ") %>].all?(&:valid?)
+    <%- argument_parameters.each do |arg| -%>
+    #   errors.merge! <%= arg %>.errors
+    <%- end -%>
+    #   return
+    # end
+    #
+    # # do something...
+    #
+    # nil
+    <%- end -%>
+  end
+  <%- if arguments.any? -%>
+
+  private
+
+  attr_reader <%= argument_parameters.map { |arg| ":#{arg}" }.join(", ") %>
+  <%- end -%>
+end

data/lib/simpler_command.rb

@@ -4,6 +4,8 @@ require "simpler_command/version"
 require "simpler_command/string_utils"
 require "simpler_command/errors"
 
+require "simpler_command/railtie" if defined? Rails::Railtie
+
 # Provides a simple structure for Commands (Services).
 #
 # Prepend SimplerCommand to your Command (Service) objects and implemente a call methods.

data/lib/simpler_command/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SimplerCommand
+  # SimplerCommand Railtie.
+  class Railtie < ::Rails::Railtie
+    generators do
+      require "generators/simpler_command/simpler_command_generator"
+      require "generators/rspec/simpler_command/simpler_command_generator" if defined? RSpec::Rails
+    end
+  end
+end

data/lib/simpler_command/version.rb

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

data/simpler_command.gemspec

@@ -8,7 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ben Morrall"]
   spec.email         = ["bemo56@hotmail.com"]
 
-  spec.summary       = "Yet another simple and standardized way to build and use Commands (aka Service Objects)"
+  spec.summary       = "Yet another simple and standardized way to build and use Commands" \
+                       " (aka Service Objects)"
   spec.homepage      = "https://github.com/bmorrall/simpler_command"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simpler_command
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ben Morrall
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -29,8 +30,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/rspec/simpler_command/USAGE
+- lib/generators/rspec/simpler_command/simpler_command_generator.rb
+- lib/generators/rspec/simpler_command/templates/command_spec.rb.erb
+- lib/generators/simpler_command/USAGE
+- lib/generators/simpler_command/simpler_command_generator.rb
+- lib/generators/simpler_command/templates/command.rb.erb
 - lib/simpler_command.rb
 - lib/simpler_command/errors.rb
+- lib/simpler_command/railtie.rb
 - lib/simpler_command/string_utils.rb
 - lib/simpler_command/version.rb
 - simpler_command.gemspec