uniformity 0.2.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 434f441b346906bd048bf69911a848d6b5cd96632b4e5cc804fdf4a0c5bdf482
-  data.tar.gz: 838055a7afe31c9c7c34f1d3e9a76f714b14be469a682069bd2a665fa55ee87e
+  metadata.gz: 9ff57972dd210d6a4b81e74640cad67e64576991069151c6ea8de2919258284d
+  data.tar.gz: 283fd4a346aad44a97bc622f3e12e34e1b5152f02f521ac2c9f1932d8e9d4c4e
 SHA512:
-  metadata.gz: c62975327d3f32ecf42728485b8cbafc0aa839b7879c0a0cdb9894edf339e54203b40ad844451113ea30b131d24f5d7d71f10e1743bace1502abeaefa21804fb
-  data.tar.gz: 6be520463ffca0a537c4ab70b3800f01cc7b3867d8883ec4eba463a28153474b9aab105cdd91186fdba4fc614ae51f450bb73c67556102640d89ebbd26e938ed
+  metadata.gz: 5e0b6d7e9a6860348e4a2b98723b9bc2bf5015e7b99b8857940573cad2375c1162a7f43209a6c95d206723fbbeada431f55a15bc13f2acf02cce0829e111a16d
+  data.tar.gz: 2b9372ecf38dbd60ff9abb69ce7356d83e4047599e51620b3b06fc5021082a2eae5d9090990a1f73b341913ac8442ac7bd7a0e131d0c474baaef5edb9e7d9fdf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    uniformity (0.2.0)
+    uniformity (0.9.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,39 +1,49 @@
 # Uniformity
 
+Generates an Engine for any external service you're using in a Ruby on Rails application.
+
+The engine should contain all your code specific to the service. Now your main application is free of an untold number of implicit dependencies. Instead, it has just one: the engine that neatly sits inside the application's folder. Ditch the service by ditching _only_ the engine. Never wonder where any change in relation to the service should go.
+
+The beauty of this approach is that the engine behaves just a regular Rails application, with all the familiar folders for models, controllers, views, jobs, etcetera. The generated engine is namespaced so that it never clashes with any official Gem provided by the service. It also follows best practices so you don't have to.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'uniformity'
+gem 'uniformity', group: :development
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install uniformity
+Imagine you want to use the fictional external service `Space Babies`. Run this command:
 
-## Usage
+```
+rails generate uniformity:space_babies
+```
 
+Put all the code using this service in the `engines/space_babies` directory. Use any Rails design pattern you need. A few empty classes using the correct namespace are generated for you as a starting point.
 
-## Development
+### Dependencies
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+If your code depends on a gem, put those in the engine's `gemspec` and not in your main app. Make sure your main app has just the one dependency on the engine.
 
-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).
+After generatin', you can remove Uniformity from your Gemfile if you want. The generated engine has no dependencies whatsoever, outside from Rails. There is no harm in leaving Uniformity enabled either, since it has no run-time code.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/spacebabies/uniformity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+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/spacebabies/uniformity/blob/master/CODE_OF_CONDUCT.md).
 
-## License
+Bug reports and pull requests are welcome on GitHub at https://github.com/spacebabies/uniformity.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-## Code of Conduct
+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).
 
-Everyone interacting in the Uniformity project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/spacebabies/uniformity/blob/master/CODE_OF_CONDUCT.md).
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/uniformity/USAGE

@@ -0,0 +1,18 @@
+Description:
+    Wrap any external service with an Engine.
+
+Example:
+    Let's say your Rails application wants to send email using Postmark API.
+
+    Generate an engine to contain all code related to this interface:
+        rails generate uniformity:engine Postmark
+
+    This will create:
+        engines/<your_application>-postmark/app
+        engines/<your_application>-postmark/bin
+        engines/<your_application>-postmark/config
+        engines/<your_application>-postmark/lib
+        engines/<your_application>-postmark/Gemfile
+        engines/<your_application>-postmark/<your_application>-postmark.gemspec
+        engines/<your_application>-postmark/Rakefile
+        engines/<your_application>-postmark/README.md

data/lib/generators/uniformity/engine.rb

@@ -0,0 +1,27 @@
+module Uniformity
+  class EngineGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+
+    def add_engine_files
+      directory "engine_root", "engines/#{application_name}-#{singular_name}"
+      template "initializer.rb", "config/initializers/#{application_name}_#{singular_name}.rb"
+    end
+
+    def bundle_engine
+      gem "#{application_name}-#{singular_name}", path: "engines/#{application_name}-#{singular_name}"
+      run "bundle install"
+    end
+
+    def mount_engine
+      route "mount #{application_const_base}::#{class_name}.engine, at: '#{singular_name}'"
+    end
+
+    private
+
+    def application_const_base
+      if defined?(Rails) && Rails.application
+        Rails.application.class.name.split("::").first
+      end
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/%application_name%-%singular_name%.gemspec.tt

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "<%= application_name %>/<%= singular_name %>/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "<%= application_name %>-<%= singular_name %>"
+  s.version     = <%= application_const_base %>::<%= class_name %>::VERSION
+  s.authors     = ["Joost Baaij"]
+  s.email       = ["joost@spacebabies.nl"]
+  s.homepage    = "https://www.spacebabies.nl/"
+  s.summary     = "Engine to connect <%= application_const_base %> to <%= class_name %>"
+  s.description = "Engine to connect <%= application_const_base %> to <%= class_name %>"
+
+  s.files = Dir["{app,config,db,lib}/**/*", "Rakefile", "README.md"]
+
+  # add your gem dependencies here
+  s.add_dependency "rails"
+end

data/lib/generators/uniformity/templates/engine_root/Gemfile.tt

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Dependencies are declared in `gemspec`.
+gemspec
+
+# The exception is any dependencies that are temporary or a work in progress.
+# They should go in this file during development.
+# Remember to move these dependencies to gemspec before releasing to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/lib/generators/uniformity/templates/engine_root/README.md.tt

@@ -0,0 +1,22 @@
+# <%= application_const_base %> went to meet <%= class_name %>
+
+In this engine we've placed everything needed to facilitate this discussion.
+This way, everything is neatly contained in one place.
+
+## Usage
+1. Incoming webhooks: /<mount point>/webhooks/<action_name>
+
+## Installation
+This engine should be part of the <%= application_const_base %> Rails app.
+
+```ruby
+gem '<%= application_name %>-<%= singular_name %>', path: "engines/<%= application_name %>-<%= singular_name %>"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Questions?
+Joost Baaij, Space Babies, joost@spacebabies.nl

data/lib/generators/uniformity/templates/engine_root/Rakefile.tt

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = '<%= application_const_base %>::<%= class_name %>'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/uniformity/templates/engine_root/app/assets/stylesheets/%application_name%/%singular_name%/application.scss.tt

@@ -0,0 +1,2 @@
+// To include this in the main app:
+// @import '<%= application_name %>/<%= singular_name %>/application';

data/lib/generators/uniformity/templates/engine_root/app/controllers/%application_name%/%singular_name%/application_controller.rb.tt

@@ -0,0 +1,6 @@
+module <%= application_const_base %>
+  module <%= class_name %>
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/app/controllers/%application_name%/%singular_name%/webhooks_controller.rb.tt

@@ -0,0 +1,9 @@
+require_dependency '<%= application_name %>/<%= singular_name %>/application_controller'
+
+module <%= application_const_base %>
+  module <%= class_name %>
+    class WebhooksController < ApplicationController
+      protect_from_forgery with: :null_session
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/app/jobs/%application_name%/%singular_name%/application_job.rb.tt

@@ -0,0 +1,7 @@
+module <%= application_const_base %>
+  module <%= class_name %>
+    class ApplicationJob < ActiveJob::Base
+      self.abstract_class = true
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/app/jobs/%application_name%/%singular_name%/hello_world_job.rb.tt

@@ -0,0 +1,9 @@
+require_dependency '<%= application_name %>/<%= singular_name %>/application_job'
+
+module <%= application_const_base %>
+  module <%= class_name %>
+    class HelloWorldJob < ApplicationJob
+      self.abstract_class = true
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/app/mailers/%application_name%/%singular_name%/mailer.rb.tt

@@ -0,0 +1,6 @@
+module <%= application_const_base %>
+  module <%= class_name %>
+    class Mailer < ::ApplicationMailer
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/app/models/%application_name%/%singular_name%/application_record.rb.tt

@@ -0,0 +1,7 @@
+module <%= application_const_base %>
+  module <%= class_name %>
+    class ApplicationRecord < ::ApplicationRecord
+      self.abstract_class = true
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/bin/console.tt

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "<%= application_name %>/<%= singular_name %>"
+
+# 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/lib/generators/uniformity/templates/engine_root/bin/rails.tt

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/<%= application_name %>/<%= singular_name %>/engine', __FILE__)
+APP_PATH = File.expand_path('../../test/dummy/config/application', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/lib/generators/uniformity/templates/engine_root/config/locales/nl.yml.tt

@@ -0,0 +1,3 @@
+nl:
+  <%= application_name %>:
+    <%= singular_name %>:

data/lib/generators/uniformity/templates/engine_root/config/routes.rb.tt

@@ -0,0 +1,3 @@
+<%= application_const_base %>::<%= class_name %>::Engine.routes.draw do
+  post 'webhooks/bounce', to: 'webhooks#bounce'
+end

data/lib/generators/uniformity/templates/engine_root/lib/%application_name%/%singular_name%/configuration.rb.tt

@@ -0,0 +1,25 @@
+module <%= application_const_base %>
+  module <%= class_name %>
+    # Just a random example of structured data to store in here.
+    Credentials = Struct.new(:setting_1, :setting_2)
+
+    # Configure this engine using a block:
+    #
+    # <%= application_const_base %>::<%= class_name %>.configure do |config|
+    #   # add your configuration settings here, e.g.:
+    #   # config.<setting> = <value>
+    # end
+    #
+    # The value can be accessed with <%= application_const_base %>::<%= class_name %>.configuration.<setting>.
+    class Configuration
+      # e.g. Credentials to connect with their API.
+      # Defaults to looking up the values in ENV.
+      def credentials
+        @credentials ||= Credentials.new(
+          ENV['<%= application_name.upcase %>_<%= singular_name.upcase %>_KEY'],
+          ENV['<%= application_name.upcase %>_<%= singular_name.upcase %>_SECRET']
+        )
+      end
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/lib/%application_name%/%singular_name%/engine.rb.tt

@@ -0,0 +1,20 @@
+require 'rails/engine'
+
+module <%= application_const_base %>
+  module <%= class_name %>
+    class Engine < ::Rails::Engine
+      isolate_namespace <%= application_const_base %>::<%= class_name %>
+
+      config.autoload_paths << File.expand_path('lib', __dir__)
+
+      config.generators do |g|
+        g.test_framework :rspec
+        g.fixture_replacement :factory_bot, dir: 'spec/factories'
+      end
+
+      config.after_initialize do |app|
+        # do something in the main app here.
+      end
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/lib/%application_name%/%singular_name%/version.rb.tt

@@ -0,0 +1,5 @@
+module <%= application_const_base %>
+  module <%= class_name %>
+    VERSION = '1.0.0'
+  end
+end

data/lib/generators/uniformity/templates/engine_root/lib/%application_name%/%singular_name%.rb.tt

@@ -0,0 +1,20 @@
+require '<%= application_name %>/<%= singular_name %>/configuration'
+require '<%= application_name %>/<%= singular_name %>/engine'
+
+module <%= application_const_base %>
+  module <%= class_name %>
+    class << self
+      attr_accessor :configuration
+
+      # Allow configuration to be stored for this engine.
+      def configure
+        self.configuration ||= Configuration.new
+        yield(configuration)
+      end
+    end
+
+    def self.engine
+      Engine
+    end
+  end
+end

data/lib/generators/uniformity/templates/engine_root/lib/%application_name%/tasks/%application_name%/%singular_name%.rake.tt

@@ -0,0 +1,9 @@
+namespace :<%= application_name %> do
+  namespace :<%= singular_name %> do
+    # Hi from the generator. You can delete this task.
+    desc "👋 konichi-wa everyone!"
+    task hello: :environment do
+      puts "OHAI from the <%= application_name %>-<%= singular_name %> engine!"
+    end
+  end
+end

data/lib/generators/uniformity/templates/initializer.rb

@@ -0,0 +1,4 @@
+<%= application_const_base %>::<%= class_name %>.configure do |config|
+  # add your configuration settings here, e.g.:
+  # config.<setting> = <value>
+end

data/lib/uniformity/version.rb

@@ -1,3 +1,3 @@
 module Uniformity
-  VERSION = "0.2.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uniformity
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Joost Baaij
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,31 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/uniformity/USAGE
+- lib/generators/uniformity/engine.rb
+- lib/generators/uniformity/templates/engine_root/%application_name%-%singular_name%.gemspec.tt
+- lib/generators/uniformity/templates/engine_root/Gemfile.tt
+- lib/generators/uniformity/templates/engine_root/README.md.tt
+- lib/generators/uniformity/templates/engine_root/Rakefile.tt
+- lib/generators/uniformity/templates/engine_root/app/assets/images/%application_name%/%singular_name%/.gitkeep
+- lib/generators/uniformity/templates/engine_root/app/assets/stylesheets/%application_name%/%singular_name%/application.scss.tt
+- lib/generators/uniformity/templates/engine_root/app/controllers/%application_name%/%singular_name%/application_controller.rb.tt
+- lib/generators/uniformity/templates/engine_root/app/controllers/%application_name%/%singular_name%/webhooks_controller.rb.tt
+- lib/generators/uniformity/templates/engine_root/app/jobs/%application_name%/%singular_name%/application_job.rb.tt
+- lib/generators/uniformity/templates/engine_root/app/jobs/%application_name%/%singular_name%/hello_world_job.rb.tt
+- lib/generators/uniformity/templates/engine_root/app/mailers/%application_name%/%singular_name%/mailer.rb.tt
+- lib/generators/uniformity/templates/engine_root/app/models/%application_name%/%singular_name%/application_record.rb.tt
+- lib/generators/uniformity/templates/engine_root/app/views/%application_name%/%singular_name%/.gitkeep
+- lib/generators/uniformity/templates/engine_root/bin/console.tt
+- lib/generators/uniformity/templates/engine_root/bin/rails.tt
+- lib/generators/uniformity/templates/engine_root/config/locales/nl.yml.tt
+- lib/generators/uniformity/templates/engine_root/config/routes.rb.tt
+- lib/generators/uniformity/templates/engine_root/lib/%application_name%/%singular_name%.rb.tt
+- lib/generators/uniformity/templates/engine_root/lib/%application_name%/%singular_name%/configuration.rb.tt
+- lib/generators/uniformity/templates/engine_root/lib/%application_name%/%singular_name%/engine.rb.tt
+- lib/generators/uniformity/templates/engine_root/lib/%application_name%/%singular_name%/version.rb.tt
+- lib/generators/uniformity/templates/engine_root/lib/%application_name%/tasks/%application_name%/%singular_name%.rake.tt
+- lib/generators/uniformity/templates/initializer.rb
 - lib/uniformity.rb
 - lib/uniformity/version.rb
 - uniformity.gemspec