mutations_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97cc68333b5701d9effc3801c5b63c27099b8926291bcb2972ae9c5c53c8663b
+  data.tar.gz: 2cb85f674e04c8f92d1e65ff6877946ffb51d1c7594836a9d08e81c4731da5ff
+SHA512:
+  metadata.gz: 37afed42f7997559d9569eecce9e9005e339bec0e867bf00c5ee5e234e8a5a43703a0959958dfa855be408b0d18bee586ffb8721893ff2c5c4af3b2a52893a27
+  data.tar.gz: 569928075db80fa724a163752f2deb3b9b160d8ced7aac9c5bbaee090750218d3f4e443f80c8c3f905e8f32e46d931d322838b9024c23de88e71430308c30edb

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mutation_generator.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,145 @@
+PATH
+  remote: .
+  specs:
+    mutations_generator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    mutations (0.9.1)
+      activesupport
+    nio4r (2.5.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (12.3.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mutations (~> 0.9.1)
+  mutations_generator!
+  rails (~> 6.0.3.1)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 robertsimoes
+
+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,34 @@
+# MutationsGenerator
+
+Rails generator extension for the [mutations](https://github.com/cypriss/mutations) framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mutations_generator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mutations_generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/build_gem_local

@@ -0,0 +1 @@
+rm -f mutations_generator-0.1.0.gem && gem build mutations_generator.gemspec && gem install mutations_generator-0.1.0.gem

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mutations_generator"
+
+# 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/generators/mutation/USAGE

@@ -0,0 +1,10 @@
+Description:
+  Adds a new Mutation to your application. Provide the mutation name as CamelCased or snake_cased.
+   Pass a list of inputs as arguments with their types and if they are required or optional.
+	 This generates a mutation class in app/mutations.
+
+Example:
+    rails generate mutation PumpTheJam technotronic:model:required space_jam:string:optional
+
+    This will create:
+        app/mutations/pump_the_jam.rb

data/lib/generators/mutation/mutation_generator.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+class MutationGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  argument :inputs, type: :array, default: [], banner: 'attribute[:filter][:required] attribute[:filter][:optional]'
+
+  def create_mutation_file
+    mutation_dir_path = 'app/mutations'
+    generator_path = mutation_dir_path + "/#{file_name}.rb"
+
+    Dir.mkdir(mutation_dir_path) unless File.exist?(mutation_dir_path)
+
+    set_local_assigns!
+
+    template 'mutation.erb', generator_path
+  end
+
+  def set_local_assigns!
+    ins = inputs.clone
+    attributes = ins.map { |i| GeneratedAttribute.parse(i) }
+    @required = attributes.select { |a| a.input_type == 'required' }
+    @optional = attributes.select { |a| a.input_type == 'optional' }
+    @klass_name = file_name.camelize
+  end
+
+  class GeneratedAttribute
+    FILTER_OPTIONS = %w[string integer model hash array boolean date duck input symbol time].freeze
+    INPUT_OPTIONS = %w[required optional].freeze
+
+    attr_accessor :name, :filter, :input_type
+
+    class << self
+      def parse(definition)
+        name, filter, input_type = definition.split(':')
+        raise 'name required' if name.nil?
+        raise 'filter type required' if filter.nil?
+
+        input_type ||= 'required'
+
+        filter = validate_filter!(filter)
+        input_type = validate_input_type!(input_type)
+        name = name.to_sym
+
+        new(name, filter, input_type)
+      end
+
+      def validate_input_type!(input_type)
+        unless INPUT_OPTIONS.include?(input_type)
+          raise "invalid input type must be one of #{INPUT_OPTIONS}"
+        end
+
+        input_type
+      end
+
+      def validate_filter!(filter)
+        unless FILTER_OPTIONS.include?(filter)
+          raise "invalid filter type must be one of #{FILTER_OPTIONS}"
+        end
+
+        filter
+      end
+    end
+
+    def initialize(name, filter, input_type)
+      @name = name
+      @filter = filter || 'string'
+      @input_type = input_type || 'required'
+    end
+  end
+end

data/lib/generators/mutation/templates/mutation.erb

@@ -0,0 +1,26 @@
+class <%= @klass_name %> < Mutations::Command
+<% if !@required.empty? %>
+  required do
+  <% @required.each do |i|%>
+    <%= i.filter %> :<%= i.name %>
+  <% end %>
+  end
+<% end %>
+
+<% if !@optional.empty? %>
+  optional do
+  <% @optional.each do |i|%>
+    <%= i.filter %> :<%= i.name %>
+  <% end %>
+  end
+<% end %>
+
+  def validate
+   # TODO your validation logic goes here
+   # add_error(:input, :symbol_error, "There has been a major malfunction")
+  end 
+
+  def execute
+   # TODO your business logic goes here
+  end
+end

data/lib/mutations_generator.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'mutations_generator/version'
+
+module MutationsGenerator
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/mutations_generator/version.rb

@@ -0,0 +1,3 @@
+module MutationsGenerator
+  VERSION = "0.1.0"
+end

data/mutations_generator.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mutations_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mutations_generator'
+  spec.version       = MutationsGenerator::VERSION
+  spec.authors       = ['robertsimoes']
+  spec.email         = ['robertsimoes@users.noreply.github.com']
+
+  spec.summary       = 'Extension for Ruby on Rails to add Mutation generators'
+  spec.description   = 'Mutations are an elegant implementation of the Command and ServiceObject pattern in Ruby on Rails projects. This gem extends Rails generators to include a mutation generator.'
+  spec.homepage      = 'https://github.com/robertsimoes'
+  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/robertsimoes'
+  spec.metadata['changelog_uri'] = spec.metadata['source_code_uri'] + '/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(__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']
+  spec.add_development_dependency 'mutations', '~> 0.9.1'
+  spec.add_development_dependency 'rails', '~>6.0.3.1'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: mutations_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- robertsimoes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mutations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+description: Mutations are an elegant implementation of the Command and ServiceObject
+  pattern in Ruby on Rails projects. This gem extends Rails generators to include
+  a mutation generator.
+email:
+- robertsimoes@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/build_gem_local
+- bin/console
+- bin/setup
+- lib/generators/mutation/USAGE
+- lib/generators/mutation/mutation_generator.rb
+- lib/generators/mutation/templates/mutation.erb
+- lib/mutations_generator.rb
+- lib/mutations_generator/version.rb
+- mutations_generator.gemspec
+homepage: https://github.com/robertsimoes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/robertsimoes
+  source_code_uri: https://github.com/robertsimoes
+  changelog_uri: https://github.com/robertsimoes/releases
+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: Extension for Ruby on Rails to add Mutation generators
+test_files: []