tollgate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94d233fa9f7310bce51a6d0cf61154cdf049cc21
+  data.tar.gz: daea04c2bc3e1c9e3fa93a983f5bfe80fafaf16b
+SHA512:
+  metadata.gz: 4d61be8dd37695e6663989f2f7a7b4ec2116ada5c8349b86853bb25941ed563cc2263cc00aa32ad5f4cbfcbc8c1efb955ea2af95b5b52dc7ea7a1656a6cf5eeb
+  data.tar.gz: 318b4e329bdd1619b6ad98a8b2867b3822465a941ba2106ddcbab9ba0945af09f493f138c974931e66a47c51183669b7dfafc90e38bfe36ea0d2965a079e3573

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.ruby-version

@@ -0,0 +1 @@
+2.3.5

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joe@joejames.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tollgate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    tollgate (0.1.0)
+      dry-core (~> 0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    dry-core (0.4.4)
+      concurrent-ruby (~> 1.0)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tollgate!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.md

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to http://unlicense.org/

data/README.md

@@ -0,0 +1,127 @@
+# Tollgate
+
+Have you paid your code toll? To get your code into the groomed and uniform metropolis
+where the static analysers enforcers run the place then you need to put extra effort
+and pay the code toll. Build a better future!
+
+Making it easy to add static code analysers to your workflow.
+Build a list of shell commands to execute and check your code locally and on your CI server.
+
+For a successful tollgate check all the commands will return a zero exit code,
+if any of the commands return a non-zero exit code then the tollgate will also
+return a non-zero exit code, which when used on CI will fail the build.
+
+## Quickstart
+
+Add the gem to your project:
+
+```rb
+group :development do
+  gem "tollgate", require: false
+end
+```
+
+Define a configuration file at `config/tollgate_config.rb`
+
+```rb
+Tollgate.config do
+  check "rubocop"
+  check "brakeman"
+  check "rspec"
+end
+```
+
+Then use the `tollgate` command to run your tollgate:
+
+```sh
+$ tollgate
+# ... output from commands being check
+
+PASS: rubocop
+PASS: brakeman
+FAIL rspec
+```
+
+## Grouping Commands
+
+Sometimes you may want several checks to run regardless if one of them has failed,
+so that you can make related changes before running the tollgate again.
+
+For instance `rubocop` and `standard` check for Ruby and JavaScript
+code styles and it makes sense for you to get the output of both of these at the same time.
+Whereas `rubocop` and `rspec` are not related in their information, and running a test
+suite takes longer, so you would probably like to get the tollgate to fail early so
+that you can fix the style changes before running the tollgate again.
+
+```rb
+Tollgate.config do
+  group :styles do
+    check "rubocop"
+    check "standard | snazzy"
+  end
+  
+  check "rspec"
+end
+```
+
+```sh
+$ tollgate
+# ... output from checks being run
+
+PASS: rubocop
+FAIL: standard | snazzy
+NOT RUN: rspec
+```
+
+You do not need to specify a group name if you can't think of one, (naming things is hard!),
+and you can specify as many as you like:
+
+```rb
+Tollgate.config do
+  group do
+    check "rubocop"
+    check "standard | snazzy"
+  end
+
+  group do
+    check "brakeman"
+    check "rails_best_practices"
+  end
+
+  check "rspec"
+  check "cucumber"
+end
+```
+In the example above, if the first group fails then the second group will not be run, nor will
+any checks that come later in the list, the output would look like:
+
+```sh
+# ...
+
+FAIL: rubocop
+PASS: standard | snazzy
+NOT RUN: brakeman
+NOT RUN: rails_best_practices
+NOT RUN: rspec
+NOT RUN: cucumber
+
+Tollgate failed.
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tollgate-ex. 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.
+
+## Code of Conduct
+
+Everyone interacting in the Tollgate::Ex project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tollgate-ex/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project uses an unlicense, all code is in the public domain, see LICENSE.md for more details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require "tollgate"
+
+Kernel.exit Tollgate::CLI.()

data/lib/tollgate.rb

@@ -0,0 +1,18 @@
+require "dry/core/constants"
+require "tollgate/cli"
+require "tollgate/runner"
+require "tollgate/errors"
+
+module Tollgate
+  class << self
+    attr_accessor :command_block
+  end
+
+  def self.configure(&block)
+    self.command_block = block
+  end
+
+  def self.reset!
+    self.command_block = nil
+  end
+end

data/lib/tollgate/cli.rb

@@ -0,0 +1,19 @@
+module Tollgate
+  module CLI
+    module_function
+
+    DEFAULT_CONFIG_PATH = "./config/tollgate_config.rb"
+
+    def call(config_path: DEFAULT_CONFIG_PATH)
+      load(config_path) if File.exist?(config_path)
+
+      reporter = Reporter.new
+      runner = Runner.new(reporter: reporter)
+      runner.(Tollgate.command_block || raise(Errors::NoConfiguration))
+
+      puts reporter.report(success: runner.success?)
+
+      runner.success?
+    end
+  end
+end

data/lib/tollgate/errors.rb

@@ -0,0 +1,6 @@
+require_relative "errors/no_configuration"
+
+module Tollgate
+  module Errors
+  end
+end

data/lib/tollgate/errors/no_configuration.rb

@@ -0,0 +1,23 @@
+module Tollgate
+  module Errors
+    class NoConfiguration < StandardError
+      def message
+        <<~TEXT
+
+
+          ERROR: There is no configuration block defined for Tollgate
+          ==========================================================
+
+          Create a file at `#{CLI::DEFAULT_CONFIG_PATH}` and define your tollgate using the `check` method:
+
+          ```
+          Tollgate.configure do
+            check "an_executable_in_my_path"
+            check "another_executable_in_my_path"
+          end
+          ```
+        TEXT
+      end
+    end
+  end
+end

data/lib/tollgate/reporter.rb

@@ -0,0 +1,45 @@
+require_relative "reporter/records"
+
+module Tollgate
+  class Reporter
+    SUCCESS_OUTPUT = "Tollgate finished successfully"
+    FAILED_OUTPUT = "Tollgate failed"
+
+    Record = Struct.new(:command, :status)
+
+    attr_reader :records
+    def initialize
+      @records = Tollgate::Reporter::Records.new
+    end
+
+    def record(command, status:)
+      @records << Record.new(command, status)
+    end
+
+    STATUSES = {
+      success: "PASS",
+      failed: "FAIL",
+      not_run: "NOT RUN"
+    }
+
+    def report(success:)
+      run_result = success ? SUCCESS_OUTPUT : FAILED_OUTPUT
+
+      <<~OUTPUT
+      #{command_statuses.join}
+      #{run_result}
+      OUTPUT
+    end
+
+    private
+
+    def command_statuses
+      @records.map do |record|
+        status = STATUSES.fetch(record.status)
+        <<~OUTPUT
+        #{status}: #{record.command}
+        OUTPUT
+      end
+    end
+  end
+end

data/lib/tollgate/reporter/records.rb

@@ -0,0 +1,15 @@
+require "delegate"
+
+module Tollgate
+  class Reporter
+    class Records < DelegateClass(Array)
+      def initialize
+        super([])
+      end
+
+      def to_a
+        map { |record| [record.command, record.status] }
+      end
+    end
+  end
+end

data/lib/tollgate/runner.rb

@@ -0,0 +1,50 @@
+require_relative "reporter"
+require_relative "runner/group"
+
+module Tollgate
+  class Runner
+    include Dry::Core::Constants
+
+    attr_reader :success
+
+    def initialize(reporter: Tollgate::Reporter.new)
+      @success = true
+      @reporter = reporter
+    end
+
+    def success?
+      !!@success
+    end
+
+    def failed?
+      !success?
+    end
+
+    def call(command_block)
+      instance_exec(&command_block)
+    end
+
+    def check(command_str)
+      return record_not_run(command_str) if failed?
+      @success = system(command_str)
+
+      if success?
+        @reporter.record(command_str, status: :success)
+      else
+        @reporter.record(command_str, status: :failed)
+      end
+    end
+
+    def group(group_name = Undefined, &command_block)
+      return if failed?
+      group_runner = Tollgate::Runner::Group.new(group_name, reporter: @reporter)
+      @success = group_runner.call(&command_block)
+    end
+
+    private
+
+    def record_not_run(command_str)
+      @reporter.record(command_str, status: :not_run)
+    end
+  end
+end

data/lib/tollgate/runner/group.rb

@@ -0,0 +1,40 @@
+module Tollgate
+  class Runner
+    class Group
+      include Dry::Core::Constants
+
+      def initialize(name = Undefined, reporter: Tollgate::Reporter.new)
+        @name = name
+        @group_status = true
+        @reporter = reporter
+      end
+
+      def group_success?
+        !!@group_status
+      end
+
+      def group_failed?
+        !group_success?
+      end
+
+      def call(&command_block)
+        puts @name unless @name == Undefined
+
+        instance_exec(&command_block) if block_given?
+
+        @group_status
+      end
+
+      def check(command_str)
+        result = system(command_str)
+        @group_status = result if group_success?
+
+        if result
+          @reporter.record(command_str, status: :success)
+        else
+          @reporter.record(command_str, status: :failed)
+        end
+      end
+    end
+  end
+end

data/lib/tollgate/version.rb

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

data/tollgate.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tollgate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tollgate"
+  spec.version       = Tollgate::VERSION
+  spec.authors       = ["the-undefined"]
+  spec.email         = ["joe@joejames.io"]
+
+  spec.summary       = %q{Configure a pipeline of checks to run to pass / fail CI}
+  spec.description   = %q{Easy way to integrate static analysers into your local and remote workflows.}
+  spec.homepage      = "https://github.com/the-undefined/tollgate"
+  spec.license       = 'Unlicense'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_runtime_dependency "dry-core", "~> 0.4"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: tollgate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- the-undefined
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Easy way to integrate static analysers into your local and remote workflows.
+email:
+- joe@joejames.io
+executables:
+- tollgate
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tollgate
+- lib/tollgate.rb
+- lib/tollgate/cli.rb
+- lib/tollgate/errors.rb
+- lib/tollgate/errors/no_configuration.rb
+- lib/tollgate/reporter.rb
+- lib/tollgate/reporter/records.rb
+- lib/tollgate/runner.rb
+- lib/tollgate/runner/group.rb
+- lib/tollgate/version.rb
+- tollgate.gemspec
+homepage: https://github.com/the-undefined/tollgate
+licenses:
+- Unlicense
+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.1
+signing_key: 
+specification_version: 4
+summary: Configure a pipeline of checks to run to pass / fail CI
+test_files: []