gem_of 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c50cb7ac955ec40f5ffa86ce19a3955aa88bc16f125565df68a2d3c892360b13
+  data.tar.gz: 8ba2454ec1cb3d326daf0cfc90614ebee730dafe8d606ce440c9c1cc10b229a4
+SHA512:
+  metadata.gz: 2534b4fb0769aa54e7b2c93edafc2085424570260ff4a4b163c326cce5ef963c001f8a70957b08c0cf0449b8ce6c59eb1a30bcd1af20f899247fc4cb43b4635e
+  data.tar.gz: 5d5f54a74993363cb1da4704af68f4b74312adc24a96d97a5a04023a94c03beb6ac1852a5be4e316b2d77e29edd98a3dfdc2a7deefc4e9ebd569d1bfa3b978ae

data/README.md

@@ -0,0 +1,58 @@
+# gem_of
+Gem testing gems, rake tasks
+
+Gemfiles are typically used solely for gems in development and testing. Are you tired of copypastaing the same Gems and rake tasks around to various projects, only to have to update them all later?
+
+use the gem_of gems!
+
+we bring you:
+
+rake, rototiller, rspec, rubocop, simplecov, yardstick, markdown, flay, flog, roodi, rubycritic, and coveralls for all your dev and unit testing needs.
+
+we bring you: beaker for your system testing needs, AND we ensure the bundle will install consistently across ruby versions by pinning old dependencies that don't seem to like following semver rules.
+
+later we'll supply a bunch of canned rake tasks to bring this all together from the CLI or CI (see our Rakefile)
+
+## currently installed gems
+
+* [rake](https://github.com/ruby/rake): "A make-like build utility for Ruby."
+* [rototiller](https://github.com/puppetlabs/rototiller): "A Rake helper library for command-oriented tasks."
+* [rspec](http://rspec.info/): "Behaviour Driven Development for Ruby."
+* [rubocop](https://github.com/bbatsov/rubocop): "A Ruby static code analyzer, based on the community Ruby style guide."
+* [simplecov](https://github.com/colszowka/simplecov): "Code coverage for Ruby 1.9+ with a powerful configuration library and automatic merging of coverage across test suites."
+* [yardstick](https://github.com/dkubb/yardstick): "A tool for verifying YARD documentation coverage."
+* [markdown](https://en.wikipedia.org/wiki/Markdown): "A lightweight markup language with plain text formatting syntax."
+* [flay](https://github.com/seattlerb/flay): "Flay analyzes code for structural similarities."
+* [flog](https://github.com/seattlerb/flog): "Flog reports the most tortured code in an easy to read pain report."
+* [roodi](https://github.com/roodi/roodi): "Ruby Object Oriented Design Inferometer"
+* [rubycritic](https://github.com/whitesmith/rubycritic): "A Ruby code quality reporter."
+* [coveralls](https://docs.coveralls.io/): "Coveralls is a web service to help you track your code coverage over time, and ensure that all your new code is fully covered."
+
+## locally install this gem
+you can't put this in your Gemfile, because we need to use it to form your Gemfile
+```
+gem install --local gem_of
+```
+or:
+```
+clone git@github.com:puppetlabs/gem_of.git
+cd gem_of
+bundle install
+bundle exec rake gem:build
+bundle exec rake gem:install:local
+```
+
+## In your Gemfile
+```
+require 'gem_of'
+
+eval(GemOf::Gems.new, binding)
+```
+
+## In your Rakefile
+gem_of distributes itself into your Gemfile, so if it's installed locally, as above, then the bundle for your other project will have it, and the rake tasks:
+```
+require "gem_of/rake_tasks"
+
+GemOf::RakeTasks.new
+```

data/lib/gem_of.rb

@@ -0,0 +1,112 @@
+require "rubygems" # for Gem Versioning methods
+
+# Namespace for Gem methods
+module GemOf
+  # produce a list of gems for use in a gems Gemfile
+  # @return [String] a string of Gemfile dependencies for a Gemfile to eval
+  # @example eval this in your Gemfile in its binding
+  #   eval(GemOf.gems, binding)
+  # @api public
+  class Gems
+    def initialize
+      set_gem_versions
+
+      @gem_code = <<-HEREDOC
+      source "https://rubygems.org"
+      # place all development, system_test, etc dependencies here
+
+      # lint/unit tests
+      gem "rake"
+      gem "gem_of"      # ensure downstream projects get gem_of for rake tasks
+      gem "rototiller", "~> 1.0"
+      gem "rspec",      "~> 3.4.0"
+      gem "rubocop",    "~> 0.49.1" # used in tests. pinned
+      gem "simplecov",  "~> 0.14.0" # used in tests
+      gem "yardstick",  "~> 0.9.0"  # used in tests
+      gem "markdown",   "~> 0"
+      gem "flay",       "~> 2.10.0" # used in tests
+      gem "flog",       "~> 4.6.0"  # used in tests
+      gem "roodi",      "~> 5.0.0"  # used in tests
+      gem "rubycritic"
+      gem "coveralls",  require: false # used in tests
+
+      group :system_tests do
+        gem "beaker",        GemOf.location_of(ENV["BEAKER_VERSION"] ||
+          "#{@beaker_version}")
+        gem "beaker-hostgenerator"
+        gem "beaker-abs",    GemOf.location_for(ENV["BEAKER_ABS_VERSION"] ||
+          "~> 0.2")
+        gem "nokogiri"       ,"#{@nokogiri_version}"
+        gem "public_suffix"  ,"#{@public_suffix_version}"
+        #gem "activesupport" ,"#{@activesupport_version}"
+      end
+
+      local_gemfile = "Gemfile.local"
+      if File.exists? local_gemfile
+        eval(File.read(local_gemfile), binding)
+      end
+
+      user_gemfile = File.join(Dir.home,".Gemfile")
+      if File.exists? user_gemfile
+        eval(File.read(user_gemfile), binding)
+      end
+      HEREDOC
+    end
+
+    # output the gem_code of this class as a string
+    #   implements both #to_str and #to_s for implicit conversions
+    # @return [String] of our gem_code
+    # @api public
+    def to_str
+      @gem_code
+    end
+    alias to_s to_str
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    # Set instance params for the various gem versions we need based upon ruby
+    #   should really only be used in above, will change, over time
+    # @api private
+    def set_gem_versions
+      # restrict gems to enable ruby versions
+
+      @public_suffix_version = "~> 1" # any
+      @activesupport_version = "~> 1" # any
+      #   nokogiri comes along for the ride but needs some restriction too
+      if Gem::Version.new(RUBY_VERSION).between?(Gem::Version.new("2.1.6"),
+                                                 Gem::Version.new("2.2.4"))
+        @beaker_version   = "<  3.9.0"
+        @nokogiri_version = "<  1.7.0"
+      elsif Gem::Version.new(RUBY_VERSION).between?(Gem::Version.new("2.0.0"),
+                                                    Gem::Version.new("2.1.5"))
+        @beaker_version   = "<  3.1.0"
+        @nokogiri_version = "<  1.7.0"
+      else
+        @beaker_version   = "~> 3.0"
+        @nokogiri_version = "~> 1" # any
+      end
+    end
+  end
+
+  # string for use as parameter to the #gem method
+  # @return [String] string for use as parameter to the #gem method
+  #   forms file or git urls, typically from user env_vars
+  # @param place [String] location string from an env_var
+  # @param fake_version [String] uh... a git sha?
+  # @api public
+  # @example
+  #   gem "beaker", GemOf.location_of(ENV["BEAKER_VERSION"] || "~> 1")
+  def location_of(place, fake_version = nil)
+    if place =~ /^(git:[^#]*)#(.*)/
+      [fake_version, { git: Regexp.last_match[1],
+                       branch: Regexp.last_match[2] }].compact
+    elsif place =~ %r{^file:\/\/(.*)}
+      [">= 0", { path: File.expand_path(Regexp.last_match[1]) }]
+    else
+      [place]
+    end
+  end
+  alias            location_for   location_of # reverse compat
+  module_function :location_for, :location_of
+end

data/lib/gem_of/rake_tasks.rb

@@ -0,0 +1,226 @@
+require "fileutils"
+require "rototiller"
+require "yard"
+require "rubocop/rake_task"
+require "flog_task"
+require "flay_task"
+require "roodi_task"
+require "rubycritic/rake_task"
+
+module GemOf
+  # a bunch of instances of other rake tasks
+  # @example create an instance of me in your rakefile
+  #   GemOf::RakeTasks.new
+  # @api public
+  class RakeTasks
+    include Rake::DSL
+    # instance a bunch of our component rake tasks
+    # @api public
+    def initialize
+      task :default do
+        sh %(rake -T)
+      end
+      GemTasks.new
+      YardStickTasks.new
+      DocsTasks.new
+      LintTasks.new
+      TestTasks.new
+    end
+  end
+
+  # a class to hold the bundler provided "gem" tasks
+  # bund of gem build, clean, install, release tasks
+  class GemTasks
+    # instance bundler gemtasks in namespace :gem
+    # @api public
+    # @example GemTasks.new
+    include Rake::DSL if defined? Rake::DSL
+    def initialize
+      namespace :gem do
+        require "bundler/gem_tasks"
+      end
+    end
+  end
+
+  # a class to hold the yardstick provided yarddoc tasks
+  class YardStickTasks
+    include Rake::DSL if defined? Rake::DSL
+    # rubocop:disable Metrics/MethodLength
+    # instance yardstick tasks in namespace :docs
+    # @api public
+    # @example YardStackTasks.new
+    def initialize
+      namespace :docs do
+        desc "Measure YARD coverage. see yardstick/report.txt for output"
+        require "yardstick/rake/measurement"
+        Yardstick::Rake::Measurement.new(:measure) do |measurement|
+          measurement.output = "yardstick/report.txt"
+        end
+
+        desc "Verify YARD coverage"
+        require "yardstick/rake/verify"
+        config = { "require_exact_threshold" => false }
+        Yardstick::Rake::Verify.new(:verify, config) do |verify|
+          verify.threshold = 80
+        end
+      end
+    end
+  end
+
+  # various yarddoc docs tasks
+  #   arch, clean, measure, undoc, verify, yard
+  class DocsTasks
+    include Rake::DSL if defined? Rake::DSL
+    # location of the yarddocs produced
+    YARD_DIR = "doc".freeze
+    # location of the human user docs (markdown, etc)
+    DOCS_DIR = "docs".freeze
+
+    # instance yardoc tasks in namespace :docs
+    # @api public
+    # @example DocsTasks.new
+    def initialize
+      namespace :docs do
+        # docs:yard task
+        YARD::Rake::YardocTask.new
+
+        desc "Clean/remove the generated YARD Documentation cache"
+        task :clean do
+          sh "rm -rf #{YARD_DIR}"
+        end
+
+        desc "Tell me about YARD undocumented objects"
+        YARD::Rake::YardocTask.new(:undoc) do |t|
+          t.stats_options = ["--list-undoc"]
+        end
+
+        desc "Generate static project architecture graph. (Calls docs:yard)"
+        # this calls `yard graph` so we can't use the yardoc tasks like above
+        #   We could create a YARD:CLI:Graph object.
+        #   But we have to send the output to the graphviz processor, etc.
+        task arch: [:yard] do
+          arch_diagram
+        end
+      end
+    end
+
+    private
+
+    # @private
+    def arch_diagram
+      original_dir = Dir.pwd
+      # this won't work all the time, and when it doesn't,
+      #   it still says we created a class diagram
+      # FIXME: use Rake.application.original_dir
+      # Dir.chdir(File.expand_path(File.dirname(__FILE__)))
+      graph_processor = "dot"
+      if exe_exists?(graph_processor)
+        FileUtils.mkdir_p(DOCS_DIR)
+        if system("yard graph --full | #{graph_processor} -Tpng " \
+            "-o #{DOCS_DIR}/arch_graph.png")
+          puts "we made you a class diagram: #{DOCS_DIR}/arch_graph.png"
+        end
+      else
+        puts "ERROR: you don't have dot/graphviz; punting"
+      end
+      Dir.chdir(original_dir)
+    end
+
+    # Cross-platform exe_exists?
+    # @private
+    def exe_exists?(name)
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{name}#{ext}")
+          return true if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+      false
+    end
+  end
+
+  # various lint-oriented tasks
+  class LintTasks
+    include Rake::DSL if defined? Rake::DSL
+    # instance lint takss in namespace :lint
+    # @api public
+    # @example LintTasks.new
+    def initialize
+      namespace :lint do
+        desc "check number of lines of code changed. No long PRs"
+        task "diff_length" do
+          diff_length? exit diff_length: exit
+        end
+
+        # this will produce 'test:rubocop','test:rubocop:auto_correct' tasks
+        RuboCop::RakeTask.new do |task|
+          task.options = ["--debug"]
+        end
+
+        # this will produce the 'test:flog' task
+        allowed_complexity = 585 # <cough!>
+        FlogTask.new :flog, allowed_complexity, %w[lib]
+        # this will produce the 'test:flay' task
+        allowed_repitition = 0
+        FlayTask.new :flay, allowed_repitition, %w[lib]
+        # this will produce the 'test:roodi' task
+        RoodiTask.new
+        # this will produce the 'test:rubycritic' task
+        RubyCritic::RakeTask.new do |task|
+          task.paths   = FileList["lib/**/*.rb"]
+        end
+      end
+    end
+
+    private
+
+    # @api private
+    def diff_length
+      max_length = 150
+      target_branch = ENV["DISTELLI_RELBRANCH"] || "master"
+      diff_cmd = "git diff --numstat #{target_branch}"
+      sum_cmd  = "awk '{s+=$1} END {print s}'"
+      diff_len = `#{diff_cmd} | #{sum_cmd}`.to_i
+      if diff_len < max_length
+        puts "diff length (#{diff_len}) is less than #{max_length} LoC"
+        return
+      else
+        puts "diff length (#{diff_len}) is more than #{max_length} LoC"
+        return diff_len
+      end
+    end
+  end
+
+  # unit testing tasks
+  class TestTasks
+    include Rake::DSL if defined? Rake::DSL
+    # instance unit tasks in namespace :test
+    # @api public
+    # @example TestTasks.new
+    def initialize
+      namespace :test do
+        begin
+          # this will produce the 'test:spec' task
+          require "rspec/core/rake_task"
+          desc "Run unit tests"
+          RSpec::Core::RakeTask.new do |t|
+            t.rspec_opts = ["--color"]
+            t.pattern = ENV["SPEC_PATTERN"]
+          end
+          # if rspec isn't available, we can still use this Rakefile
+          # rubocop:disable Lint/HandleExceptions
+        rescue LoadError
+        end
+
+        task spec: [:check_spec]
+
+        desc "" # empty description so it doesn't show up in rake -T
+        rototiller_task :check_spec do |t|
+          t.add_env(name: "SPEC_PATTERN", default: "spec/",
+                    message: "The pattern RSpec will use to find tests")
+        end
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+module GemOf
+  # namespace for the future version of this library
+  module Version
+    # the version string
+    STRING = "0.1.0".freeze
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: gem_of
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Puppet, Inc.
+- Eric Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-18 00:00:00.000000000 Z
+dependencies: []
+description: Puppet common tools and setup, for testing, building   and documenting
+  ruby projects
+email:
+- qa@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/gem_of.rb
+- lib/gem_of/rake_tasks.rb
+- lib/version.rb
+homepage: https://github.com/puppetlabs/gem_of
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Puppet Gem testing Gems, RakeTasks
+test_files: []