toolbus 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e446516a16a126e50c3638221d68fcb12478b05a
+  data.tar.gz: 6984f53761683637177632968e9c380e2a3ab4f6
+SHA512:
+  metadata.gz: 6179c6fb159e91bd7df282445e8b23b2d036323af0fc3820e5c99918d101a2599636426c2926ec77cade5336e96a8b76eeda175bc320620e24b91752b3e69633
+  data.tar.gz: 9b1f79ea4cba5ba67d7bbf96f508f0cae3f86e5df75d6834aa73ebbeb13c5c1102c88367d9dd017086c5ad01910ff3e95915716606898ae7f7649ee63605a19b

data/README.md

@@ -0,0 +1,15 @@
+Blueprint details
+
+# One reserved word:
+# ANYTHING.
+
+# Maybe others are necessary?
+# ANYTHING_MATCHING("?"). # will cast symbols and strings 
+# CONDITION. a predicate method. will be tested against all children, considered true if it passes.
+
+Todo:
+
+* Implement SyntaxTree.include?
+* Fix StatusBoxView bug - the terminal line isn't clearing properly.
+* Fill out README.
+* Test various SyntaxTree inclusions.

data/bin/toolbus

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'toolbus'
+
+Toolbus.new.scan

data/lib/toolbus.rb

@@ -0,0 +1,93 @@
+require 'json/pure'
+require 'open-uri'
+require_relative './views.rb'
+require_relative './utils.rb'
+
+TOOLBUS_ROOT = File.join(`gem which toolbus`.chomp.chomp("/lib/toolbus.rb"))
+
+class Toolbus
+  include GitUtils
+
+  def initialize
+    validate_repo
+    @features = fetch_features
+  end
+
+  def validate_repo
+    ConsoleManager.error "Unpushed commits! Push or stash before running." unless latest_commit_online?
+    ConsoleManager.error "Uncommitted changes! Stash or commit and push before running." unless git_status_clean?
+  end
+
+  def fetch_features
+    # TODO: GET all features for our tools and versions, once that API exists
+    JSON.parse(File.read(File.open(File.join(TOOLBUS_ROOT, 'spec/fixture/sample.json'))))['data']
+  end
+
+  SCAN_TIME_SECONDS = 4.0
+  def scan
+    statuses = []
+    progress = 0.0
+    @features.map { |feature| feature.default = 0 } # helps measure progress
+    num_steps = scanning_plan.inject(0) { |total, (file, blueprints)| total + blueprints.length }
+
+    scanning_plan.each_with_index do |(file, search_for), file_index|
+      statuses << "Scanning #{file}"
+      search_for.each do |search_for|
+        id = search_for.keys.first
+        blueprint = search_for.values.first
+
+        progress += 1
+        begin
+          match = SyntaxTree.new(file).include?(SyntaxTree.new(blueprint))
+        rescue Parser::SyntaxError
+          statuses << "Syntax Error: #{file}"
+          next
+        end
+
+        if match
+          feature = @features.find { |feature| feature['id'] == id }
+          feature['count'] += 1
+          statuses << "POST /completions: repo_url: #{repo_url}, feature_id: #{id}, commit: ???, filename: #{file}, first_line: #{match[:first_line]}, last_line: #{match[:last_line]}"
+        end
+
+        percent_complete = (progress / num_steps) * 100
+        ConsoleManager.repaint([
+          ProgressBarView.new(percent_complete),
+          TableView.new(features_found),
+          StatusBoxView.new(statuses),
+          "Found #{num_completions} total completions across #{num_features_completed}/#{@features.count} features across #{file_index}/#{scanning_plan.count} files!"
+        ])
+        sleep SCAN_TIME_SECONDS / num_steps
+      end
+    end
+  end
+
+  private 
+  
+  def scanning_plan
+    hash_with_array_values = Hash.new { |h, k| h[k] = [] }
+
+    @features.inject(hash_with_array_values) do |plan, feature|
+      Dir.glob(feature['search_in']).each do |file|
+        plan[file] << { feature['id'] => feature['search_for'] }
+      end
+      plan
+    end
+  end
+
+  def feature_module_and_name(feature)
+    [feature['module'], ': ', feature['name']].join
+  end
+
+  def features_found
+    @features.map { |feature| [feature_module_and_name(feature), feature['count']] }.to_h
+  end
+
+  def num_completions
+    @features.inject(0) { |total, feature| total + feature['count'] }
+  end
+
+  def num_features_completed
+    @features.select { |feature| feature['count'] > 0 }.count
+  end
+end

data/lib/utils.rb

@@ -0,0 +1,51 @@
+require 'parser/current'
+
+class SyntaxTree
+  def initialize(ruby)
+    # todo: turn on
+    # @ast = Parser::CurrentRuby.parse(ruby)
+  end
+
+  def include?(smaller_ast)
+    # TODO: find if smaller_ast is a subset of self.
+    rand < 0.4 ? { first_line: 10, last_line: 12 } : nil
+  end
+end
+
+module GitUtils
+  attr_reader :repo_url, :head_sha
+
+  def git_status_clean?
+    `git status -s`.length == 0
+  end
+
+  def latest_commit_online?
+    `git log --oneline origin/master..HEAD`.length == 0
+  end
+
+  def repo_url
+    @repo_url ||= `git config --get remote.origin.url`.gsub('git@github.com:', '').chomp
+  end
+
+  def head_sha
+    @head_sha ||= `git rev-parse HEAD`
+  end
+end
+
+# Pulled from ActionSupport.
+class String
+  def truncate(truncate_at, options = {})
+    return dup unless length > truncate_at
+
+    omission = options[:omission] || '...'
+    length_with_room_for_omission = truncate_at - omission.length
+    stop = \
+      if options[:separator]
+        rindex(options[:separator], length_with_room_for_omission) || length_with_room_for_omission
+      else
+        length_with_room_for_omission
+      end
+
+    "#{self[0, stop]}#{omission}"
+  end
+end

data/lib/views.rb

@@ -0,0 +1,74 @@
+module TerminalUtils
+  SCREEN_WIDTH = [`tput cols`.to_i, 100].min
+  SAVE_CURSOR = `tput sc`
+  RESTORE_CURSOR = `tput rc`
+  ERASE_DISPLAY = `tput clear`
+  RED = `tput setaf 1`
+  GREEN = `tput setaf 2`
+  RESET = `tput sgr0`
+end
+
+print TerminalUtils::SAVE_CURSOR
+
+class ConsoleManager
+  include TerminalUtils
+
+  def self.repaint(rows)
+    print RESTORE_CURSOR
+    num_rows = rows.flat_map(&:to_s).length
+    rows.each { |row| puts row.to_s; puts }
+  end
+
+  def self.error(message)
+    puts RED + message + RESET
+    exit
+  end
+end
+
+class ProgressBarView
+  include TerminalUtils
+  EXTRA_CHARS_OFFSET = 8 # brackets, % completion
+  USABLE_WIDTH = SCREEN_WIDTH - EXTRA_CHARS_OFFSET
+
+  def initialize(percent)
+    @percent = Float([percent, 100.0].min)
+  end
+
+  def to_s
+    complete = '#' * ((@percent / 100.0) * USABLE_WIDTH).to_i
+    incomplete = ' ' * (USABLE_WIDTH - complete.length)
+    [GREEN, ' [', complete, incomplete, ']', (@percent.to_i.to_s + '%').rjust(5), RESET].join
+  end
+end
+
+class TableView
+  include TerminalUtils
+
+  def initialize(map)
+    @map = map
+  end
+
+  def to_s
+    @map.map do |(key, count)|
+      color = count > 0 ? GREEN : RED
+      done = count > 0 ? "✓" : " "
+      description = key.truncate(SCREEN_WIDTH - 4).ljust(SCREEN_WIDTH - 3)
+      [color, done, ' ', description, count.to_s, RESET].join
+    end
+  end
+end
+
+class StatusBoxView
+  include TerminalUtils
+
+  def initialize(statuses)
+    @statuses = statuses
+  end
+
+  def to_s
+    puts '-' * SCREEN_WIDTH
+    puts
+    num_lines = @statuses.length
+    @statuses.last(8).fill(num_lines, 8 - num_lines) { '' }
+  end
+end

data/spec/fixture/sample.json

@@ -0,0 +1,87 @@
+{ 
+  "data": [{
+    "type": "feature",
+    "id": 1,
+    "name": "Optimistic locking",
+    "module": "ActiveRecord::Locking",
+    "search_in": "app/models/**/*rb",
+    "search_for": "locking_column = :ANYTHING"
+  }, {
+    "type": "feature",
+    "id": 2,
+    "name": "Pessimistic locking",
+    "module": "ActiveRecord::Locking",
+    "search_in": "app/**/*.rb",
+    "search_for": "lock! OR with_lock"
+  }, {
+    "type": "feature",
+    "id": 3,
+    "name": "Transactions",
+    "module": "ActiveRecord::Transactions",
+    "search_in": "app/**/*.rb",
+    "search_for": "class ANYTHING < ActiveRecord::Base\nend"
+  }, {
+    "type": "feature",
+    "id": 4,
+    "name": "Single table inheritance",
+    "module": "ActiveRecord::Transactions",
+    "search_in": "app/models/**/*rb",
+    "search_for": "ANYTHING < ActiveRecord::Base\nend"
+  }, {
+    "type": "feature",
+    "id": 5,
+    "name": "Alternative ActiveRecord initialization patterns",
+    "module": "ActiveRecord::Base",
+    "search_in": "app/**/*.rb",
+    "search_for": "ANYTHING.new {}"
+  }, {
+    "type": "feature",
+    "id": 6,
+    "name": "Conditions",
+    "module": "ActiveRecord::Base",
+    "search_in": "in AP,P",
+    "search_for": "where(ANYTHING_MATCHING('?'))"
+  }, {
+    "type": "feature",
+    "id": 7,
+    "name": "Saving arrays, hashes, and other non-mappable objects in text columns",
+    "module": "ActiveRecord::AttributeMethods::Serialization",
+    "search_in": "app/models/**/*rb",
+    "search_for": "serialize :ANYTHING"
+  }, {
+    "type": "feature",
+    "id": 8,
+    "name": "Connection to multiple databases in different models",
+    "module": "ActiveRecord::Base",
+    "search_in": "app/**/*.rb",
+    "search_for": "MyModel.connection OR ActiveRecord::Base.connection"
+  }, {
+    "type": "feature",
+    "id": 9,
+    "name": "Connection to MongoDB",
+    "module": "ActiveJob::Enqueuing",
+    "search_in": "app/models/**/*rb",
+    "search_for": "include Mongoid::Document"
+  }, {
+    "type": "feature",
+    "id": 10,
+    "name": "ActiveJob::Enqueueing#enqueue",
+    "module": "ActiveJob::Enqueuing",
+    "search_in": "app/**/*.rb",
+    "search_for": "enqueue"
+  }, {
+    "type": "feature",
+    "id": 11,
+    "name": "ActiveJob::Enqueueing#retry_job",
+    "module": "ActiveSupport::CoreExt",
+    "search_in": "app/jobs/*.rb",
+    "search_for": "retry_job"
+  }, {
+    "type": "feature",
+    "id": 12,
+    "name": "Benchmarking",
+    "module": "ActiveRecord::Inheritance",
+    "search_in": "app/**/*.rb",
+    "search_for": "Benchmark.ms"
+  }]
+}

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'toolbus'
+
+RSpec.configure do |config|
+
+  # These options will default to `true` in RSpec 4
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  # Kernel.srand config.seed
+
+end

data/spec/toolbus_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe Toolbus do
+  pending "write this"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: toolbus
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jason Benn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Scans and parses clean git repos, figures out how much of an API you've
+  used
+email: jasoncbenn@gmail.com
+executables:
+- toolbus
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/toolbus
+- lib/toolbus.rb
+- lib/utils.rb
+- lib/views.rb
+- spec/fixture/sample.json
+- spec/spec_helper.rb
+- spec/toolbus_spec.rb
+homepage: http://www.jbenn.net
+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.4.5
+signing_key: 
+specification_version: 4
+summary: 'To learn a tool: build projects, measure your progress with Toolbus'
+test_files:
+- spec/fixture/sample.json
+- spec/spec_helper.rb
+- spec/toolbus_spec.rb
+has_rdoc: