inch_by_inch 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6155ab24504649d54b3f3677b4ef7864f897db3f
+  data.tar.gz: 4f19858352bfb9b419f1d8197864d8c245ee0726
+SHA512:
+  metadata.gz: 4f3b14e50274f54c0ebdfad4e7f842dcb01273f277d3f7bcdbadb38b6ce4be126bd60f46d7d80c031eda5d1829bc3dd05063a237f4925a34a2017dfdc40f4e7d
+  data.tar.gz: 7f6881b6a0e0663dbf393b6902fa345451d07fecc4e4ad5c35d3f3c5eb91ed2738e66e6c278f64e54ad13e6396bc729c58fdccc4bfce596fc6a591fcf8f22dd7

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - .rubocop_cocoapods.yml
+  - .rubocop_todo.yml

data/.rubocop_cocoapods.yml

@@ -0,0 +1,126 @@
+AllCops:
+  Include:
+    - ./Rakefile
+    - ./Gemfile
+    - ./*.gemspec
+  Exclude:
+    - ./spec/fixtures/**/*
+    - ./vendor/bundle/**/*
+
+# At the moment not ready to be used
+# https://github.com/bbatsov/rubocop/issues/947
+Documentation:
+  Enabled: false
+
+#- CocoaPods -----------------------------------------------------------------#
+
+# We adopted raise instead of fail.
+SignalException:
+  EnforcedStyle: only_raise
+
+# They are idiomatic
+AssignmentInCondition:
+  Enabled: false
+
+# Allow backticks
+AsciiComments:
+  Enabled: false
+
+# Indentation clarifies logic branches in implementations
+IfUnlessModifier:
+  Enabled: false
+
+# No enforced convention here.
+SingleLineBlockParams:
+  Enabled: false
+
+# We only add the comment when needed.
+Encoding:
+  Enabled: false
+
+# Having these make it easier to *not* forget to add one when adding a new
+# value and you can simply copy the previous line.
+TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# Clashes with CLAide Command#validate!
+GuardClause:
+  Enabled: false
+
+# Not always desirable: lib/claide/command/plugins_helper.rb:12:15
+Next:
+  Enabled: false
+
+# Arbitrary max lengths for classes simply do not work and enabling this will
+# lead to a never ending stream of annoyance and changes.
+Metrics/ClassLength:
+  Enabled: false
+
+# Arbitrary max lengths for modules simply do not work and enabling this will
+# lead to a never ending stream of annoyance and changes.
+Metrics/ModuleLength:
+  Enabled: false
+
+# Arbitrary max lengths for methods simply do not work and enabling this will
+# lead to a never ending stream of annoyance and changes.
+Metrics/MethodLength:
+  Enabled: false
+
+# No enforced convention here.
+Metrics/BlockNesting:
+  Enabled: false
+
+# It will be obvious which code is complex, Rubocop should only lint simple
+# rules for us.
+Metrics/AbcSize:
+  Enabled: false
+
+# It will be obvious which code is complex, Rubocop should only lint simple
+# rules for us.
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+# It will be obvious which code is complex, Rubocop should only lint simple
+# rules for us.
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+#- CocoaPods support for Ruby 1.8.7 ------------------------------------------#
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Lambda:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+EachWithObject:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+#- CocoaPods specs -----------------------------------------------------------#
+
+# Allow for `should.match /regexp/`.
+AmbiguousRegexpLiteral:
+  Exclude:
+    - spec/**/*
+
+# Allow `object.should == object` syntax.
+Void:
+  Exclude:
+    - spec/**/*
+
+ClassAndModuleChildren:
+  Exclude:
+    - spec/**/*
+
+UselessComparison:
+  Exclude:
+    - spec/**/*

data/.rubocop_todo.yml

@@ -0,0 +1,22 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-12-05 15:50:06 -0600 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'lib/inch_by_inch/rake_task.rb'
+
+# Offense count: 5
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 129
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/inch_by_inch/progress_enumerable.rb'

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+InchByInch Changelog
+
+## 1.0.0 (2015-12-08)
+
+* Initial import and refactor of code from the CocoaPods Rakefile.  
+  [Samuel Giddins](https://github.com/segiddins)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at segiddins@segiddins.me. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inch_by_inch.gemspec
+gemspec
+
+group :development do
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    inch_by_inch (1.0.0)
+      inch (~> 0.7.0)
+      rake (~> 10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    coderay (1.1.0)
+    inch (0.7.0)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.8.7.5)
+    method_source (0.8.2)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    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)
+    slop (3.6.0)
+    sparkr (0.4.1)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    tins (1.6.0)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11.pre)
+  inch_by_inch!
+  rubocop
+
+BUNDLED WITH
+   1.11.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marius Rackwitz, Samuel Giddins
+
+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,54 @@
+# InchByInch
+
+A rake task to make validating your documentation comments as easy as running
+a single command.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'inch_by_inch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inch_by_inch
+
+## Usage
+
+In your `Rakefile`, add the following:
+
+```ruby
+# Rakefile
+require 'inch_by_inch/rake_task'
+InchByInch::RakeTask.new
+```
+
+## 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 `rake install`. To
+release a new version, update the version number in `version.rb`, commit,
+and then run `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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/inch_by_inch. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+task :default => [:inch, :rubocop]
+
+task :bootstrap do
+  sh 'bundle install'
+end
+
+begin
+  require 'bundler/gem_tasks'
+  require 'bundler/setup'
+
+  require 'inch_by_inch/rake_task'
+  InchByInch::RakeTask.new
+
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError, NameError => e
+  $stderr.puts "\033[0;31m" \
+    '[!] Some Rake tasks haven been disabled because the environment' \
+    ' couldn’t be loaded. Be sure to run `rake bootstrap` first or use the ' \
+    "VERBOSE environment variable to see errors.\e[0m"
+  if ENV['VERBOSE']
+    $stderr.puts e.message
+    $stderr.puts e.backtrace
+    $stderr.puts
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'inch_by_inch'
+
+# 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

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/inch_by_inch.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inch_by_inch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'inch_by_inch'
+  spec.version       = InchByInch::VERSION
+  spec.authors       = ['Marius Rackwitz', 'Samuel Giddins']
+  spec.email         = ['gems@mariusrackwitz.de', 'segiddins@segiddins.me']
+
+  spec.summary       = 'A rake task to pretty-print documentation violations.'
+  spec.homepage      = 'https://github.com/segiddins/inch_by_inch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'inch', '~> 0.7.0'
+  spec.add_runtime_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11.pre'
+end

data/lib/inch_by_inch.rb

@@ -0,0 +1,5 @@
+require 'inch_by_inch/version'
+
+module InchByInch
+  # Your code goes here...
+end

data/lib/inch_by_inch/progress_enumerable.rb

@@ -0,0 +1,16 @@
+module InchByInch
+  class ProgressEnumerable
+    include Enumerable
+
+    def initialize(array)
+      @array = Array(array)
+    end
+
+    def each
+      @array.each do |e|
+        print '.'
+        yield e
+      end.tap { puts }
+    end
+  end
+end

data/lib/inch_by_inch/rake_task.rb

@@ -0,0 +1,85 @@
+require 'rake'
+require 'rake/tasklib'
+
+require 'inch_by_inch/progress_enumerable'
+
+module InchByInch
+  class RakeTask < Rake::TaskLib
+    attr_accessor :failing_grades
+    attr_accessor :codebase_dir
+
+    # Initializes a rake task
+    #
+    # @param [#to_s] task_name
+    #        the name of the rake task.
+    #
+    def initialize(task_name = :inch)
+      @failing_grades = %I(B C)
+      @codebase_dir = Dir.pwd
+
+      yield self if block_given?
+
+      install_task(task_name)
+    end
+
+    private
+
+    def install_task(task_name)
+      desc 'Lint the completeness of the documentation with Inch' unless ::Rake.application.last_comment
+      task(task_name) do
+        require 'inch'
+        require 'inch/cli'
+        verify_docs!
+      end
+    end
+
+    def verify_docs!
+      install_ui_hooks
+
+      puts 'Parsing docs…'
+
+      codebase = Inch::Codebase.parse(codebase_dir, Inch::Config.codebase)
+      context = Inch::API::List.new(codebase, {})
+
+      failing_grade_symbols = failing_grades.map(&:to_sym)
+      failing_grade_list = context.grade_lists.select { |g| failing_grade_symbols.include?(g.to_sym) }
+      Inch::CLI::Command::Output::List.new(options, context.objects, failing_grade_list) # just initializing will run the command
+      puts
+      if context.objects.any? { |o| failing_grade_symbols.include?(o.grade.to_sym) }
+        puts red('✗ Lint of Documentation failed: Please improve above suggestions.')
+        exit 1
+      else
+        puts green('✓ Nothing to improve detected.')
+      end
+    end
+
+    def install_ui_hooks
+      YARD::Parser::SourceParser.before_parse_file do |_|
+        print green('.') # Visualize progress
+      end
+
+      Inch::Codebase::Objects.class_eval do
+        alias_method :old_init, :initialize
+        def initialize(language, objects)
+          puts "\n\nEvaluating…"
+          old_init(language, ProgressEnumerable.new(objects))
+        end
+      end
+    end
+
+    def options
+      @options ||= Inch::CLI::Command::Options::List.new.tap do |options|
+        options.show_all = true
+        options.ui = Inch::Utils::UI.new
+      end
+    end
+
+    def green(string)
+      "\033[0;32m#{string}\e[0m"
+    end
+
+    def red(string)
+      "\033[0;31m#{string}\e[0m"
+    end
+  end
+end

data/lib/inch_by_inch/version.rb

@@ -0,0 +1,3 @@
+module InchByInch
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: inch_by_inch
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marius Rackwitz
+- Samuel Giddins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.pre
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.pre
+description: 
+email:
+- gems@mariusrackwitz.de
+- segiddins@segiddins.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_cocoapods.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- inch_by_inch.gemspec
+- lib/inch_by_inch.rb
+- lib/inch_by_inch/progress_enumerable.rb
+- lib/inch_by_inch/rake_task.rb
+- lib/inch_by_inch/version.rb
+homepage: https://github.com/segiddins/inch_by_inch
+licenses:
+- MIT
+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.5.0
+signing_key: 
+specification_version: 4
+summary: A rake task to pretty-print documentation violations.
+test_files: []
+has_rdoc: