tablexi_dev-generators 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56152f0209f0fc9d78f53fc96e874842beb38b3c
+  data.tar.gz: 57e1da7ecb905db9a828752d0dc0c77f3addeea5
+SHA512:
+  metadata.gz: 59f41aac68253ffba890d70abf74568f6797156ff22163c0539afd8120d0e6cc1a8a75b7419d54c91e38f0067fa7b6e6c52c34d00604a2f9a9be591622764cdd
+  data.tar.gz: 0a41f308c023d0630fb1b38bf88222526f6ab6568eaf32d7b0f043262178d8f2b3f48680089d0dee51be98b70b5e97b64bedcea8d2c058a1fb815c50c29d488c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jason Hanggi
+
+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,66 @@
+# Table XI Dev Generators
+
+A recommended set of generators for Table XI projects.
+
+## Example usage
+
+Install everything:
+
+```bash
+bundle exec rails g tablexi_dev:all
+```
+
+Or install only the ones you want:
+
+```bash
+bundle exec rails g tablexi_dev:git_hook
+bundle exec rails g tablexi_dev:rubocop
+bundle exec rails g tablexi_dev:unicorn
+# ...
+```
+
+## Installing this gem
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem "tablexi_dev-generators"
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Upgrading this gem
+
+After upgrading this gem, it's recommended that you re-run the generators and verify that the changed files are correct.
+
+## All available generators
+
+### Generator: Git hooks
+
+    bundle exec rails g tablexi_dev:git_hook
+
+This generator will guide you through installing git hooks. If you do not have a strong preference, we recommend installing the `pre-push` rubocop hook.
+
+Because git hooks do not get checked into the remote repository, it's recommended that each team member run this generator upon installing any project on their local machine.
+
+### Generator: Rubocop
+
+    bundle exec rails g tablexi_dev:rubocop
+
+The rubocop generator is designed to be used in the following different situations:
+
+1) On initial setup of rubocop in a project, to set up the tool.
+2) When updates to the rubocop cops occur (new versions of [Rubocop](https://github.com/bbatsov/rubocop/) are provided, with new rules)
+
+For detailed instructions on the rubocop generator and its options, [check out the rubocop readme](rubocop.md)
+
+### Generator: Unicorn
+
+    bundle exec rails g tablexi_dev:rubocop
+
+The unicorn generator sets up a project's unicorn configuration files.

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+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    = "TablexiDev::Generators"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+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/tablexi_dev/all_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module TablexiDev
+
+  module Generators
+
+    class AllGenerator < Rails::Generators::Base
+
+      GENERATORS = %i[
+        git_hook
+        rubocop
+        unicorn
+      ].freeze
+
+      def generate_all
+        GENERATORS.each { |generator| generate "tablexi_dev:#{generator}" }
+      end
+
+    end
+
+  end
+
+end

data/lib/generators/tablexi_dev/git_hook_generator/files/general-pre-commit

@@ -0,0 +1,2 @@
+#!/bin/sh
+# This is a general pre-commit hook, other hooks will be invoked from here

data/lib/generators/tablexi_dev/git_hook_generator/files/general-pre-push

@@ -0,0 +1,2 @@
+#!/bin/sh
+# This is a general pre-push hook, other hooks will be invoked from here

data/lib/generators/tablexi_dev/git_hook_generator/files/rubocop-pre-commit

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubocop"
+
+ADDED_OR_MODIFIED = /A|AM|^M/
+
+# to prevent code injection: system is a dangerous call
+def raise_single_quote_error
+  raise ArgumentError, "Single quotes are not allowed in filenames here."
+end
+
+def extract_file_name(file_name_with_status)
+  file_name_array = file_name_with_status.strip.split(" ")
+  file_name_array.shift
+  fname = file_name_array.join(" ")
+  fname[0] = "" if fname[0] == '"'
+  fname[fname.length - 1] = "" if fname[fname.length - 1] == '"'
+  raise_single_quote_error if fname.include?("'")
+  fname
+end
+
+changed_files =
+  `git status --porcelain`
+  .split(/\n/)
+  .select { |file_name_with_status| file_name_with_status =~ ADDED_OR_MODIFIED }
+  .map { |file_name_with_status| extract_file_name file_name_with_status }
+  .select { |file_name| File.extname(file_name) =~ /.rb/ }
+  .join("' '")
+
+unless changed_files.empty?
+  system("bundle exec rubocop -a --force-exclusion '#{changed_files}'")
+  system("git add '#{changed_files}'")
+end
+
+exit $CHILD_STATUS.to_s[-1].to_i

data/lib/generators/tablexi_dev/git_hook_generator/files/rubocop-pre-push

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# We choose not to auto-correct so that the return code is non-0
+# causing the pre-push to prevent the 'git push' from doing it.
+# This will run Rubocop on all files tracked with git, ignoring any files in the
+# repo's .gitignore or your .gitignore_global.
+
+bundle exec rubocop --force-exclusion `git ls-tree -r HEAD --name-only`

data/lib/generators/tablexi_dev/git_hook_generator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module TablexiDev
+
+  module Generators
+
+    class GitHookGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../git_hook_generator/files/", __FILE__)
+
+      def copy_files
+        maybe_install_rubocop_hook_pre "push"
+        maybe_install_rubocop_hook_pre "commit"
+      end
+
+      private
+
+      def maybe_install_rubocop_hook_pre(type)
+        return unless yes?("Would you like to automatically run rubocop before each 'git #{type}'?")
+
+        # Define pre-hook file paths
+        rubocop_path = ".git/hooks/rubocop-pre-#{type}"
+        general_path = ".git/hooks/pre-#{type}"
+
+        # Copy files from this generator into the project
+        copy_and_set_executable("rubocop-pre-#{type}", rubocop_path)
+        copy_and_set_executable("general-pre-#{type}", general_path) unless File.exist?(general_path)
+
+        # Ensure we do not append to the general hook file more than once
+        unless File.readlines(general_path).grep(/rubocop-pre-#{type}/).size > 0
+          append_to_file(general_path, "exec #{rubocop_path}")
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/generators/tablexi_dev/rubocop_generator/files/dot_rubocop-project_overrides.yml

@@ -0,0 +1,11 @@
+# Overrides can go here, but try to conform to TXI standards when possible.
+#
+# Example...
+# Metrics/CyclomaticComplexity:
+#   Enabled: false # We've got nasty methods!
+#
+#
+# Example...
+# AllCops:
+#   TargetRubyVersion: 2.3
+#   TargetRailsVersion: 4.2

data/lib/generators/tablexi_dev/rubocop_generator/files/dot_rubocop-txi.yml

@@ -0,0 +1,100 @@
+# This file is generated as a part of the tablexi_dev-generators project
+#
+# You should NOT make any changes to this file, as it will be overwritten
+# the next time we update the tablexi_dev-generators gem and run
+# `rails generate tablexi_dev:rubocop`
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - "db/schema.rb" # You can't touch this
+    - ".bundle/**/*" # Auto-generated
+    - "bin/**/*"     # Auto-generated
+    - "vendor/**/*"  # We cannot solve the world's problems
+  TargetRubyVersion: 2.4
+  TargetRailsVersion: 5.1
+Rails:
+  Enabled: true
+
+Lint/HandleExceptions:
+  Exclude:
+    - "config/unicorn/*"
+
+Metrics/AbcSize:
+  Max: 25
+  Exclude:
+    - "db/**/*" # Sometimes migrations are complex.
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - "db/**/*" # Again, sometimes DB migrations are long.
+
+Metrics/BlockLength:
+  Exclude:
+    # These are naturally DSL-y, and so let's be lenient.
+    - "spec/**/*"
+    - "config/routes.rb"
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "app/controllers/**/*" # We generally use compact style here
+
+Style/Documentation:
+  Exclude:
+    - "db/**/*" # No need to require migrations to be documented.
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    # These are naturally DSL-y, and so let's be lenient.
+    - "spec/**/*"
+    - "lib/tasks/*.rake"
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+  Exclude:
+    - "db/**/*" # Migrations are compact by default, and it's not worth the wrestle.
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+
+Layout/ExtraSpacing:
+  Exclude:
+    - "db/migrate/*" # Generated migrations often have extra spacing
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Layout/SpaceBeforeFirstArg:
+  Exclude:
+    # We often add extra spaces for alignment in factories.
+    - "spec/factories/**/*"
+    - "db/migrate/*" # We often add extra spaces for alignment in migrations.
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrivialAccessors:
+  ExactNameMatch: true
+
+Rails/UnknownEnv:
+  Environments:
+    - production
+    - development
+    - test
+    - stage
+
+Rails/ApplicationRecord:
+  Exclude:
+    - "db/**/*" # Migrations should be isolated, models defined there should NOT inherit from ApplicationRecord

data/lib/generators/tablexi_dev/rubocop_generator/files/dot_rubocop.yml

@@ -0,0 +1,15 @@
+# This file is generated as a part of the tablexi_dev-generators project
+#
+# You should NOT make any changes to this file, as it will be overwritten
+# the next time we update the tablexi_dev-generators gem and run
+# `rails generate tablexi_dev:rubocop`
+inherit_from:
+  - .rubocop-txi.yml
+  - .rubocop-project_overrides.yml
+  - .rubocop_todo.yml
+
+# Allow the list of files Excluded by .rubocop-txi to be merged
+# with files excluded by the .rubocop-project_overrides and .rubocop_todo files
+inherit_mode:
+  merge:
+    - Exclude

data/lib/generators/tablexi_dev/rubocop_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module TablexiDev
+
+  module Generators
+
+    class RubocopGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../rubocop_generator/files/", __FILE__)
+
+      def copy_files
+        install_rubocop_config_files
+      end
+
+      def add_gem
+        # Prevent us from adding the same gem directive multiple times
+        # if the Gemfile already has 'rubocop' in a format other
+        # than the exact format we expect.
+        content = File.read("Gemfile")
+        gem "rubocop", group: %i[development test], require: false unless content.include?("rubocop")
+      end
+
+      private
+
+      def install_rubocop_config_files
+        copy_file "dot_rubocop.yml", ".rubocop.yml"
+        copy_file "dot_rubocop-txi.yml", ".rubocop-txi.yml"
+
+        # Create a .rubocop_todo file, which may be generated
+        # by the `rubocop --auto-gen-config` command
+        create_file ".rubocop_todo.yml" unless File.exist?(".rubocop_todo.yml")
+
+        # Create a file for where individual project-overrides
+        # should be stored, and not be clobbered by the txi rules
+        unless File.exist?(".rubocop-project_overrides.yml") # rubocop:disable Style/GuardClause
+          copy_file "dot_rubocop-project_overrides.yml", ".rubocop-project_overrides.yml"
+        end
+      end
+
+      def copy_and_set_executable(source_file, target_file)
+        copy_file source_file, target_file
+        chmod target_file, 0o755
+      end
+
+    end
+
+  end
+
+end

data/lib/generators/tablexi_dev/unicorn_generator/templates/production.rb.tt

@@ -0,0 +1,36 @@
+worker_processes 4
+listen "/tmp/unicorn-<%= @production_domain %>.socket", backlog: 64
+preload_app true
+
+app_path = "/home/<%= @app_name %>/<%= @production_domain %>"
+working_directory "#{app_path}/current"
+pid               "#{app_path}/shared/tmp/pids/unicorn.pid"
+
+stderr_path "log/unicorn.stderr.log"
+stdout_path "log/unicorn.stdout.log"
+
+# zero downtime
+before_fork do |server, _|
+  # the following is highly recomended for Rails + "preload_app true"
+  # as there's no need for the master process to hold a connection
+  ActiveRecord::Base.connection.disconnect! if defined?(ActiveRecord::Base)
+
+  # Before forking, kill the master process that belongs to the .oldbin PID.
+  # This enables 0 downtime deploys.
+  old_pid = "#{server.config[:pid]}.oldbin"
+  if File.exist?(old_pid) && server.pid != old_pid
+    begin
+      Process.kill("QUIT", File.read(old_pid).to_i)
+    rescue Errno::ENOENT, Errno::ESRCH
+      # someone else did our job for us
+    end
+  end
+end
+
+after_fork do |_, _|
+  ActiveRecord::Base.establish_connection if defined?(ActiveRecord::Base)
+end
+
+before_exec do |_|
+  ENV["BUNDLE_GEMFILE"] = "#{app_path}/current/Gemfile"
+end

data/lib/generators/tablexi_dev/unicorn_generator/templates/stage.rb.tt

@@ -0,0 +1,36 @@
+worker_processes 2
+listen "/tmp/unicorn-<%= @app_name %>.stage.tablexi.com.socket", backlog: 64
+preload_app true
+
+app_path = "/home/<%= @app_name %>/<%= @app_name %>.stage.tablexi.com"
+working_directory "#{app_path}/current"
+pid               "#{app_path}/shared/tmp/pids/unicorn.pid"
+
+stderr_path "log/unicorn.stderr.log"
+stdout_path "log/unicorn.stdout.log"
+
+# zero downtime
+before_fork do |server, _|
+  # the following is highly recomended for Rails + "preload_app true"
+  # as there's no need for the master process to hold a connection
+  ActiveRecord::Base.connection.disconnect! if defined?(ActiveRecord::Base)
+
+  # Before forking, kill the master process that belongs to the .oldbin PID.
+  # This enables 0 downtime deploys.
+  old_pid = "#{server.config[:pid]}.oldbin"
+  if File.exist?(old_pid) && server.pid != old_pid
+    begin
+      Process.kill("QUIT", File.read(old_pid).to_i)
+    rescue Errno::ENOENT, Errno::ESRCH
+      # someone else did our job for us
+    end
+  end
+end
+
+after_fork do |_, _|
+  ActiveRecord::Base.establish_connection if defined?(ActiveRecord::Base)
+end
+
+before_exec do |_|
+  ENV["BUNDLE_GEMFILE"] = "#{app_path}/current/Gemfile"
+end

data/lib/generators/tablexi_dev/unicorn_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module TablexiDev
+
+  module Generators
+
+    class UnicornGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../unicorn_generator/templates", __FILE__)
+
+      def set_variables
+        @app_name = Rails.application.class.parent.to_s.underscore
+        user_answer = ask("What is the production domain? (leave blank if you don't know yet)")
+        @production_domain = user_answer.presence || "[production-domain]"
+      end
+
+      def add_files
+        template "stage.rb", "config/unicorn/stage.rb"
+        template "production.rb", "config/unicorn/production.rb"
+      end
+
+      def add_gem
+        gem "unicorn", require: false
+      end
+
+    end
+
+  end
+
+end

data/lib/tablexi_dev/generators/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TablexiDev
+
+  module Generators
+
+    VERSION = "0.1.0"
+
+  end
+
+end

data/lib/tablexi_dev/generators.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TablexiDev
+
+  module Generators
+    # Your code goes here...
+  end
+
+end

data/lib/tasks/tablexi_dev/generators_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :tablexi_dev_generators do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: tablexi_dev-generators
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Table XI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- devs@tablexi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/tablexi_dev/all_generator.rb
+- lib/generators/tablexi_dev/git_hook_generator.rb
+- lib/generators/tablexi_dev/git_hook_generator/files/general-pre-commit
+- lib/generators/tablexi_dev/git_hook_generator/files/general-pre-push
+- lib/generators/tablexi_dev/git_hook_generator/files/rubocop-pre-commit
+- lib/generators/tablexi_dev/git_hook_generator/files/rubocop-pre-push
+- lib/generators/tablexi_dev/rubocop_generator.rb
+- lib/generators/tablexi_dev/rubocop_generator/files/dot_rubocop-project_overrides.yml
+- lib/generators/tablexi_dev/rubocop_generator/files/dot_rubocop-txi.yml
+- lib/generators/tablexi_dev/rubocop_generator/files/dot_rubocop.yml
+- lib/generators/tablexi_dev/unicorn_generator.rb
+- lib/generators/tablexi_dev/unicorn_generator/templates/production.rb.tt
+- lib/generators/tablexi_dev/unicorn_generator/templates/stage.rb.tt
+- lib/tablexi_dev/generators.rb
+- lib/tablexi_dev/generators/version.rb
+- lib/tasks/tablexi_dev/generators_tasks.rake
+homepage: https://github.com/tablexi/tablexi_dev-generators
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A recommended set of generators for Table XI projects..
+test_files: []