orderly_garden 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65be954c3ee21801615b979c34e9c7b357755879
+  data.tar.gz: 7b2a8ca405d5d3322ccccc7b5998f86c3e2c2bdf
+SHA512:
+  metadata.gz: f155b50d2a9efbe55ef0651f5e571fadd6e5efcc9ca1b29a48bd1fa47f2872fae401c6f28ee9e22160f313a8d2ac2e8d84caf50550e1901047dfb33826c93431
+  data.tar.gz: 6afc74ce6db4041a7d248adb8faa1dbd01bac04bbf43ea08912d9ba97e420c6887368dc058370acb52049203e0c0cf6097f85f2a5a218a1b1c84f06070fbf66c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.rubocop.yml

data/Gemfile

@@ -0,0 +1,8 @@
+# rubocop:disable Style/LeadingCommentSpace
+#ruby-gemset=orderly_garden
+# rubocop:enable Style/LeadingCommentSpace
+source "https://rubygems.org"
+ruby "2.2.3"
+
+# Specify your gem's dependencies in orderly_garden.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    orderly_garden (0.1.0)
+      bundler-audit (> 0)
+      rake (~> 10.0)
+      rubocop (> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    bundler-audit (0.4.0)
+      bundler (~> 1.2)
+      thor (~> 0.18)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rubocop (0.35.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.3.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      tins (<= 1.6.0)
+    ruby-progressbar (1.7.5)
+    thor (0.19.1)
+    tins (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  orderly_garden!
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jon Frisby
+
+MIT License
+
+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,91 @@
+# OrderlyGarden
+
+A set of tools for Rake and Ruby workflows, to help keep things neat and tidy.
+
+* `parent_task`: Automatically run all sub-tasks in a namespace when the namespace-named task is run.
+* Limit the number of Rake threads to a sane number by default.
+* Lint metric for code volume if `cloc` is installed.
+* Ruby style enforcement, and slightly saner Rubocop defaults.
+* Dependency checking with `bundler-audit`, and `bundle outdated`.
+* `with_tempfile`: Manage a temp file for you, and optionally replace a destination path with it upon success.
+* `write_file`: Write an array of strings to a file ensuring they're joined by newlines and have a trailing newline.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "orderly_garden", require: false, git: "git@github.com:MrJoy/orderly_garden.git"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install orderly_garden
+```
+
+
+## Usage
+
+TODO: Write usage instructions here.  Hint, try `rake -T`.
+
+### Setup
+
+1. In `Rakefile`, add this -- replacing the domain name with the URL of your private Docker registry:
+    ```ruby
+    require "rubygems"
+    require "bundler/setup"
+    Bundler.require(:default, :development, :test)
+    require "orderly_gardem"
+    OrderlyGarden.init!
+    ```
+1. Create a file named `.rubocop.local.yml` with your own Rubocop rules / configuration.
+    * This will be merged with the saner defaults provided by `orderly_garden` when running `rake lint:rubocop`.
+1. Add `/.rubocop.yml` to your `.gitignore` file, as this will be auto-generated.
+
+### Running The Tools
+
+```bash
+rake lint # Run all `lint:*` tasks.  Includes `bundler-audit` and `Rubocop` by default.
+```
+
+### Custom Lint Tasks
+
+To add a task that gets executed when you run `rake lint`, simply create it in the `lint` namespace:
+
+```ruby
+namespace :lint do
+  desc "Some sort of lint check for your project.  Will be included in `rake lint` automatically."
+  task :my_check do
+  end
+end
+```
+
+### Making Your Own Auto-Discovery Task Groups
+
+```ruby
+desc "Run all `my_group:*` tasks."
+parent_task :my_group
+
+namespace :my_group do
+  desc "Some task to include in `rake my_group`."
+  task :some_task do
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/MrJoy/orderly_garden/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+$LOAD_PATH << "./lib"
+
+require "orderly_garden"
+OrderlyGarden.init!

data/config/rubocop_rules.yml

@@ -0,0 +1,109 @@
+# TODO: Eliminate all Bundler binstub files properly.
+AllCops:
+  Exclude:
+    - bin/bundle
+    - bin/bundle-audit
+    - bin/rails
+    - bin/rake
+    - bin/spring
+    - db/schema.rb
+    - tmp/**/*
+
+Lint/FormatParameterMismatch:
+  Enabled: true
+
+# Lint/OptionHash:
+#   Enabled: true
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Exclude:
+  - 'db/migrate/*'
+
+Performance/StringReplacement:
+  Enabled: true
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/AlignHash:
+  EnforcedColonStyle: table
+  # TODO: Err, maybe keys here?
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Style/CollectionMethods:
+  PreferredMethods:
+    find: detect
+    inject: reduce
+    collect: map
+    find_all: select
+
+# Allow comments to be aligned to one another.
+Style/CommentIndentation:
+  Enabled: false
+
+# Don't bother with class documentation for Rails application class, and DB
+# migrations.
+Style/Documentation:
+  Exclude:
+  - 'db/migrate/*'
+  - 'config/application.rb'
+  - '**/version.rb'
+
+# We like the truthiness operator.
+Style/DoubleNegation:
+  Enabled: false
+
+# Style/DotPosition:
+#   EnforcedStyle: trailing
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Style/ExtraSpacing:
+  AllowForAlignment: true
+
+Style/FormatString:
+  EnforcedStyle: 'String#%'
+  SupportedStyles: 'String#%'
+
+# Style/GuardClause:
+#   Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/LineEndConcatenation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: false
+
+Style/RescueEnsureAlignment:
+  Enabled: true
+
+# Style/RescueModifier:
+#   Enabled: false
+
+# We like terse methods.
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/SpaceAroundOperators:
+  MultiSpaceAllowedForOperators:
+    - '='
+    - '=>'
+    - '||='
+    - '+='
+    - '-='
+    - '*='
+    - '/='
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+  SupportedStyles: comma

data/lib/orderly_garden/dsl.rb

@@ -0,0 +1,36 @@
+module OrderlyGarden
+  # Rake DSL constructs.
+  module DSL
+    # Create and manage a temp file, replacing `fname` with the temp file, if `fname` is provided.
+    def with_tempfile(fname = nil, &block)
+      Tempfile.open("tmp") do |f|
+        block.call(f.path, f.path.shellescape)
+        FileUtils.cp(f.path, fname) unless fname.nil?
+      end
+    end
+
+    # Write an array of strings to a file, adding newline separators, and
+    # ensuring a trailing newline at the end of a file.
+    def write_file(file_name, file_contents)
+      contents =  file_contents
+                  .flatten
+                  .select { |line| line }
+                  .join("\n")
+      File.open(file_name, "w") do |fh|
+        fh.write(contents)
+        fh.write("\n")
+      end
+    end
+
+    # Define a task named `name` that runs all tasks under an identically named `namespace`.
+    def parent_task(name)
+      task name do
+        Rake::Task
+          .tasks
+          .select { |t| t.name =~ /^#{name}:/ }
+          .sort { |a, b| a.name <=> b.name }
+          .each(&:execute)
+      end
+    end
+  end
+end

data/lib/orderly_garden/monkey_patches.rb

@@ -0,0 +1,11 @@
+# rubocop:disable Style/Documentation
+# Monkey-patch `String` and `Pathname` with some handy-dandy helpers.
+
+class String
+  def to_pathname; Pathname.new(self); end
+end
+
+class Pathname
+  def to_pathname; self; end
+end
+# rubocop:enable Style/Documentation

data/lib/orderly_garden/version.rb

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

data/lib/orderly_garden.rb

@@ -0,0 +1,36 @@
+require "pathname"
+require "shellwords"
+
+require "rake/clean"
+
+# A set of tools for Rake and Ruby workflows, to help keep things neat and tidy.
+module OrderlyGarden
+  # Initialize `orderly_garden`.  Configures Rake, and loads some handy tasks.
+  def self.init!
+    # TODO: Pare this to CPU count, or possibly half that because hyperthreading usually is not our
+    # TODO: friend.
+    Rake.application.options.thread_pool_size ||= 4
+    # Time.zone = 'America/Los_Angeles'
+
+    task_files.each { |fname| load fname }
+  end
+
+protected
+
+  def self.task_files
+    task_dir        = File.expand_path("../../../tasks", __FILE__)
+    raw_task_files  = FileList["#{task_dir}/**/*.rake"] +
+                      FileList["tasks/**/*.rake"]
+    raw_task_files
+      .map { |fname| File.expand_path(fname) }
+      .sort
+      .uniq
+  end
+end
+
+require "orderly_garden/monkey_patches"
+require "orderly_garden/version"
+require "orderly_garden/dsl"
+
+# TODO: Make this optional.
+include OrderlyGarden::DSL

data/orderly_garden.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "orderly_garden/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "orderly_garden"
+  spec.version       = OrderlyGarden::VERSION
+  spec.authors       = ["Jon Frisby"]
+  spec.email         = ["jfrisby@mrjoy.com"]
+  spec.summary       = "A set of tools for Rake and Ruby workflows, to help keep things neat and"\
+                       " tidy."
+  spec.homepage      = "https://github.com/MrJoy/orderly_garden"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+
+  spec.add_runtime_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "bundler-audit", "> 0"
+  spec.add_runtime_dependency "rubocop", "> 0"
+end

data/tasks/lint.rake

@@ -0,0 +1,55 @@
+RUBOCOP_HEADING = "# #{('WARNING!  ' * 7).rstrip}\n"\
+                  "# AUTO-GENERATED FILE!  DO NOT EDIT DIRECTLY!\n"\
+                  "\n"\
+                  "# Override from `.rubocop.local.yml` and re-run `rake lint:rubocop` instead!\n"
+
+namespace :lint do
+  desc "Run Rubocop against the codebase."
+  task :rubocop do
+    require "yaml"
+    puts "Running Rubocop..."
+    defaults_file           = File.expand_path("../../config/rubocop_rules.yml", __FILE__)
+    defaults                = YAML.load(File.read(defaults_file))
+    local_opts              = ".rubocop.local.yml"
+    overrides               = YAML.load(File.read(local_opts)) if File.exist?(local_opts)
+    overrides             ||= {}
+
+    # Be slightly intelligent about merging AllCops, but allow overriding things:
+    overrides["AllCops"]  ||= {}
+    o_allcops               = overrides["AllCops"]
+    d_allcops               = defaults["AllCops"] || {}
+    o_allcops["Exclude"] ||= d_allcops["Exclude"] if d_allcops.key?("Exclude")
+    o_allcops["Include"] ||= d_allcops["Include"] if d_allcops.key?("Include")
+
+    results = (RUBOCOP_HEADING + defaults.merge(overrides).to_yaml).rstrip
+    write_file(".rubocop.yml", [results])
+    sh "rubocop --display-cop-names"
+  end
+
+  desc "Run bundler-audit against the Gemfile."
+  task :'bundler-audit' do
+    require "bundler/audit/cli"
+
+    %w(update check).each do |command|
+      Bundler::Audit::CLI.start [command]
+    end
+  end
+
+  if `which clock`.strip != ""
+    desc "Show LOC metrics for project using cloc."
+    task :cloc do
+      # TODO: Make this list customizable.
+      sh "cloc . --exclude-dir=coverage,.bundle,tmp"
+    end
+  end
+
+  desc "Check for outdated gems."
+  task :bundler do
+    # Don't error-out if this fails, since we may not be able to update some
+    # deps.
+    sh "bundle outdated || true"
+  end
+end
+
+desc "Run all lint checks against the code."
+parent_task :lint

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: orderly_garden
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Frisby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jfrisby@mrjoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.local.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/rubocop_rules.yml
+- lib/orderly_garden.rb
+- lib/orderly_garden/dsl.rb
+- lib/orderly_garden/monkey_patches.rb
+- lib/orderly_garden/version.rb
+- orderly_garden.gemspec
+- tasks/lint.rake
+homepage: https://github.com/MrJoy/orderly_garden
+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.0
+signing_key: 
+specification_version: 4
+summary: A set of tools for Rake and Ruby workflows, to help keep things neat and
+  tidy.
+test_files: []