prospectus 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0a2847a778e51cf212ecec194f6b2775dfaec87
-  data.tar.gz: fc19c435c6987f97b451390cff3065de791b0a57
+  metadata.gz: 8f56ad02011f3a9e8e71e0dd976d899d4b1f2662
+  data.tar.gz: 490bb12b8ad993b4c2e45ce724c9f98bc0efab67
 SHA512:
-  metadata.gz: cb4db8ffb9c25ad460b57a99a23db2718b7841b0a6b7d22bdf46a6fd53792ea2201d0b09cc3e530e77b4a8fcadb145dc664b0956fa2759c7ad8a163886c0b398
-  data.tar.gz: 5c6c6f81be6ab3ce203f08502a811bac539809b782074aba96c8e12f2641b97b21d3cfd1acfa37b87d25eb4a03e61c6646be5fce5cdc8da0ba7f464d832151dd
+  metadata.gz: 00d3aaf31da7499f7f3372644631aa422b5288828705cfaeaff12dc840c3735bc7ef240c3e090b0749e8f7d3759f75b71b6d784ab410060befecc4554e9ca378
+  data.tar.gz: 2bfc8e02c7460827542404d3c4c0db17fb1d7788125f0ca08790d8ced78a170f7d7cbfb5246a4b9f6d492e1480aca2e8026f494b7eeb7fad4cfd514d2366d4cc

data/README.md

@@ -5,13 +5,59 @@ prospectus
 [![Dependency Status](https://img.shields.io/gemnasium/akerl/prospectus.svg)](https://gemnasium.com/akerl/prospectus)
 [![Build Status](https://img.shields.io/circleci/project/akerl/prospectus.svg)](https://circleci.com/gh/akerl/prospectus)
 [![Coverage Status](https://img.shields.io/codecov/c/github/akerl/prospectus.svg)](https://codecov.io/github/akerl/prospectus)
-[![Code Quality](https://img.shields.io/codacy/.svg)](https://www.codacy.com/app/akerl/prospectus)
+[![Code Quality](https://img.shields.io/codacy/36b84b3bc7b24cd4991c4753f7788850.svg)](https://www.codacy.com/app/akerl/prospectus)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
 
-DSL and tool for checking for state changes
+Write short scripts in a simple DSL and use the prospectus tool to check for changes in expected vs. actual state.
+
+I use this for checking my [homebrew tap](https://github.com/halyard/homebrew-formulae) and [ArchLinux packages](https://github.com/amylum) for outdated package versions: it compares the version I'm packaging now against the upstream latest version.
 
 ## Usage
 
+This gem reads a "./.prospectus" file to determine expected/actual state. A prospectus file can be pretty lightweight:
+
+```
+item do
+  name 'zlib'
+
+  expected do
+    github_release
+    repo 'madler/zlib'
+    regex /^v(.*)$/
+  end
+
+  actual do
+    git_tag
+    regex /^(.*)-\d+$/
+  end
+end
+```
+
+Prospectus works by letting you define "items", each of which have an "expected" and "actual" block. You can specify a "name", as above, otherwise it will infer the name from the directory containing the prospectus file.
+
+The expected/actual blocks first define the module to be used, and then define any configuration for that module.
+
+To run the check, just run `prospectus` in the directory with the .prospectus file, or use `prospectus -d /path/to/directory`.
+
+## Included Modules
+
+### static_test
+
+Used for testing, this allows you to manually declare a state:
+
+```
+item do
+  expected do
+    static_test
+    set '0.0.3'
+  end
+  actual do
+    static_test
+    set '0.0.1'
+  end
+end
+```
+
 ## Installation
 
     gem install prospectus

data/Rakefile

@@ -7,7 +7,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc 'Run Rubocop on the gem'
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb', 'bin/*']
   task.fail_on_error = true
 end
 

data/bin/prospectus

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'prospectus'
+require 'mercenary'
+
+Mercenary.program(:prospectus) do |p|
+  p.version Prospectus::VERSION
+  p.description 'Tool and DSL for checking expected vs actual state'
+  p.syntax 'prospectus [options]'
+
+  # rubocop:disable Metrics/LineLength
+  p.option :directory, '-d DIR', '--directory DIR', 'Change to directory before loading'
+  p.option :good_only, '-g', '--good', 'Show only items with good state'
+  p.option :all, '-a', '--all', 'Show all items'
+  # rubocop:enable Metrics/LineLength
+
+  p.action do |_, options|
+    options[:directory] ||= '.'
+    Dir.chdir(options[:directory]) do
+      Prospectus.load_from_file(options).check.each do |x|
+        puts "#{x.name}: #{x.actual} / #{x.expected}"
+      end
+    end
+  end
+end

data/lib/prospectus.rb

@@ -0,0 +1,54 @@
+require 'logcabin'
+
+##
+# Tool and DSL for checking expected vs actual state
+module Prospectus
+  DEFAULT_FILE = './.prospectus'
+
+  class << self
+    ##
+    # Insert a helper .new() method for creating a new Cache object
+    def new(*args)
+      self::List.new(*args)
+    end
+
+    ##
+    # Method for loading list from DSL
+    def load_from_file(params = {})
+      params[:file] ||= DEFAULT_FILE
+      list = List.new(params)
+      dsl = ListDSL.new(list, params)
+      dsl.instance_eval(File.read(params[:file]), params[:file])
+      list
+    end
+
+    def modules
+      @modules ||= LogCabin.new(load_path: load_path(:modules))
+    end
+
+    def helpers
+      @helpers ||= LogCabin.new(load_path: load_path(:helpers))
+    end
+
+    def extra_dep(name, dep)
+      require dep
+    rescue LoadError
+      raise("The #{name} module requires the #{dep} gem")
+    end
+
+    private
+
+    def gem_dir
+      Gem::Specification.find_by_name('prospectus').gem_dir
+    end
+
+    def load_path(type)
+      File.join(gem_dir, 'lib', 'prospectus', type.to_s)
+    end
+  end
+end
+
+require 'prospectus/version'
+require 'prospectus/list'
+require 'prospectus/item'
+require 'prospectus/state'

data/lib/prospectus/helpers/github_api.rb

@@ -0,0 +1,26 @@
+Prospectus.extra_dep('github_api', 'octoauth')
+
+module LogCabin
+  module Modules
+    ##
+    # Provide an api method for modules to query GitHub
+    module GithubApi
+      def github_api
+        @github_api ||= Octokit::Client.new(
+          access_token: auth.token,
+          auto_paginate: true
+        )
+      end
+
+      private
+
+      def auth
+        @auth ||= Octoauth.new(
+          note: 'Prospectus',
+          file: :default,
+          autosave: true
+        )
+      end
+    end
+  end
+end

data/lib/prospectus/helpers/regex.rb

@@ -0,0 +1,20 @@
+module LogCabin
+  module Modules
+    ##
+    # Use regex to adjust state value
+    module Regex
+      def regex_helper(value)
+        return value unless @find
+        fail("Value does not match regex: #{value}") unless value.match(@find)
+        value.sub(@find, @replace)
+      end
+
+      private
+
+      def regex(find, replace = '\1')
+        @find = find
+        @replace = replace
+      end
+    end
+  end
+end

data/lib/prospectus/item.rb

@@ -0,0 +1,63 @@
+module Prospectus
+  ##
+  # Define item objects that defined expected vs actual state
+  class Item
+    attr_reader :list
+
+    def initialize(params = {})
+      @options = params
+      @list = List.new(params)
+    end
+
+    def name
+      @name ||= File.basename Dir.pwd
+    end
+
+    def expected
+      @expected || fail("No expected state was loaded for #{name}")
+    end
+
+    def actual
+      @actual || fail("No actual state was loaded for #{name}")
+    end
+  end
+
+  ##
+  # DSL for wrapping eval of item files
+  class ItemDSL
+    def initialize(item, params)
+      @item = item
+      @options = params
+    end
+
+    def name(value)
+      @item.instance_variable_set(:@name, value)
+    end
+
+    def expected(&block)
+      state(:@expected, &block)
+    end
+
+    def actual(&block)
+      state(:@actual, &block)
+    end
+
+    def deps(&block)
+      dsl = ListDSL.new(@item.list, @options)
+      dsl.instance_eval(&block)
+      @item.list.items.each do |dep|
+        dep.instance_variable_set(:@name, "#{@item.name}::#{dep.name}")
+      end
+    end
+
+    private
+
+    def state(name, &block)
+      state = State.new(@options)
+      dsl = StateDSL.new(state, @options)
+      dsl.instance_eval(&block)
+      dsl.load!
+      @item.instance_variable_set(name, state.value)
+    end
+  end
+end

data/lib/prospectus/list.rb

@@ -0,0 +1,38 @@
+module Prospectus
+  ##
+  # Define list object that contains items
+  class List
+    def initialize(params = {})
+      @options = params
+    end
+
+    def items
+      @items ||= []
+    end
+
+    def check
+      all, good_only = @options.values_at(:all, :good_only)
+      items.select do |x|
+        match = x.expected == x.actual
+        true if all || (!match ^ good_only)
+      end
+    end
+  end
+
+  ##
+  # DSL for wrapping eval of list files
+  class ListDSL
+    def initialize(list, params)
+      @list = list
+      @options = params
+    end
+
+    def item(&block)
+      item = Item.new(@options)
+      dsl = ItemDSL.new(item, @options)
+      dsl.instance_eval(&block)
+      @list.items << item
+      item.list.items.each { |x| @list.items << x }
+    end
+  end
+end

data/lib/prospectus/modules/gemnasium.rb

@@ -0,0 +1,66 @@
+Prospectus.extra_dep('gemnasium', 'netrc')
+require 'net/http'
+require 'json'
+
+module LogCabin
+  module Modules
+    ##
+    # Pull state from Gemnasium
+    module Gemnasium
+      def load!
+        fail('No slug provided') unless @slug
+        @state.value = parse_api
+      end
+
+      private
+
+      def parse_api
+        %w(red yellow).each do |color|
+          return color if colors.include? color
+        end
+        'green'
+      end
+
+      def colors
+        @colors ||= api_data.map { |x| x['first_level'] && x['color'] }
+      end
+
+      def api_data
+        @resp ||= Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+          request = Net::HTTP::Get.new uri.request_uri
+          request.basic_auth(*creds)
+          response = http.request(request)
+          JSON.parse(response.body)
+        end
+      end
+
+      def creds
+        netrc[site] || prompt_for_creds
+      end
+
+      def prompt_for_creds
+        puts 'Please enter your API key from https://gemnasium.com/settings >> '
+        resp = gets.chomp
+        netrc[site] = 'X', resp
+        netrc.save
+        netrc[site]
+      end
+
+      def netrc
+        @netrc ||= Netrc.read
+      end
+
+      def uri
+        @uri ||= URI("https://api.gemnasium.com/projects/#{@slug}/dependencies")
+      end
+
+      def site
+        'gemnasium.com'
+      end
+
+      def slug(value)
+        @slug = value
+      end
+    end
+  end
+end

data/lib/prospectus/modules/git_tag.rb

@@ -0,0 +1,14 @@
+module LogCabin
+  module Modules
+    ##
+    # Pull state from a git tag
+    module GitTag
+      include Prospectus.helpers.find(:regex)
+
+      def load!
+        tag = `git describe --tags --abbrev=0`.chomp
+        @state.value = regex_helper(tag)
+      end
+    end
+  end
+end

data/lib/prospectus/modules/github_release.rb

@@ -0,0 +1,28 @@
+require 'json'
+require 'open-uri'
+
+module LogCabin
+  module Modules
+    ##
+    # Pull state from a GitHub release
+    module GithubRelease
+      include Prospectus.helpers.find(:regex)
+      include Prospectus.helpers.find(:github_api)
+
+      def load!
+        fail('No repo specified') unless @repo
+        @state.value = regex_helper(release)
+      end
+
+      private
+
+      def release
+        @release ||= github_api.latest_release(@repo).tag_name
+      end
+
+      def repo(value)
+        @repo = value
+      end
+    end
+  end
+end

data/lib/prospectus/modules/github_tag.rb

@@ -0,0 +1,28 @@
+require 'json'
+require 'open-uri'
+
+module LogCabin
+  module Modules
+    ##
+    # Pull state from a GitHub tag
+    module GithubTag
+      include Prospectus.helpers.find(:regex)
+      include Prospectus.helpers.find(:github_api)
+
+      def load!
+        fail('No repo specified') unless @repo
+        @state.value = regex_helper(tag)
+      end
+
+      private
+
+      def tag
+        @tag ||= github_api.tags(@repo).first.name
+      end
+
+      def repo(value)
+        @repo = value
+      end
+    end
+  end
+end

data/lib/prospectus/modules/grep.rb

@@ -0,0 +1,29 @@
+module LogCabin
+  module Modules
+    ##
+    # Pull state from a local file
+    module Grep
+      include Prospectus.helpers.find(:regex)
+
+      def load!
+        fail('No file specified') unless @file
+        line = read_file
+        @state.value = regex_helper(line)
+      end
+
+      private
+
+      def read_file
+        File.read(@file).each_line do |line|
+          line = line.chomp
+          return line if line.match(@find)
+        end
+        fail("No lines in #{@file} matched #{@find}")
+      end
+
+      def file(value)
+        @file = value
+      end
+    end
+  end
+end

data/lib/prospectus/modules/static.rb

@@ -0,0 +1,18 @@
+module LogCabin
+  module Modules
+    ##
+    # Simple text class, uses "set 'value'" to declare value
+    module Static
+      def load!
+        fail('Must use `set` to provide a value') unless @value
+        @state.value = @value
+      end
+
+      private
+
+      def set(value)
+        @value = value
+      end
+    end
+  end
+end

data/lib/prospectus/modules/url_xpath.rb

@@ -0,0 +1,35 @@
+Prospectus.extra_dep('url_xpath', 'nokogiri')
+
+require 'open-uri'
+
+module LogCabin
+  module Modules
+    ##
+    # Pull state from a GitHub tag
+    module UrlXpath
+      include Prospectus.helpers.find(:regex)
+
+      def load!
+        fail('No url provided') unless @url
+        fail('No xpath provided') unless @xpath
+        text = parse_page
+        @state.value = regex_helper(text)
+      end
+
+      private
+
+      def parse_page
+        page = Nokogiri::HTML(open(@url)) { |config| config.strict.nonet }
+        page.xpath(@xpath).text
+      end
+
+      def url(value)
+        @url = value
+      end
+
+      def xpath(value)
+        @xpath = value
+      end
+    end
+  end
+end

data/lib/prospectus/state.rb

@@ -0,0 +1,27 @@
+module Prospectus
+  ##
+  # Define a state object that supports modular checks
+  class State
+    attr_accessor :value
+
+    def initialize(params = {})
+      @options = params
+    end
+  end
+
+  ##
+  # DSL for wrapping eval of states
+  class StateDSL
+    def initialize(state, params)
+      @state = state
+      @options = params
+    end
+
+    def method_missing(method, *args, &block)
+      return super if @module
+      @module = Prospectus.modules.find(method)
+      return super unless @module
+      extend @module
+    end
+  end
+end

data/lib/prospectus/version.rb

@@ -0,0 +1,5 @@
+##
+# Declare package version
+module Prospectus
+  VERSION = '0.0.2'
+end

data/prospectus.gemspec

@@ -1,10 +1,13 @@
+$:.unshift File.expand_path('../lib/', __FILE__)
+require 'prospectus/version'
+
 Gem::Specification.new do |s|
   s.name        = 'prospectus'
-  s.version     = '0.0.1'
+  s.version     = Prospectus::VERSION
   s.date        = Time.now.strftime('%Y-%m-%d')
 
-  s.summary     = 'DSL and tool for checking for state changes'
-  s.description = "DSL and tool for checking for state changes"
+  s.summary     = 'Tool and DSL for checking expected vs actual state'
+  s.description = "Tool and DSL for checking expected vs actual state"
   s.authors     = ['Les Aker']
   s.email       = 'me@lesaker.org'
   s.homepage    = 'https://github.com/akerl/prospectus'
@@ -12,12 +15,14 @@ Gem::Specification.new do |s|
 
   s.files       = `git ls-files`.split
   s.test_files  = `git ls-files spec/*`.split
+  s.executables = ['prospectus']
+
+  s.add_dependency 'mercenary', '~> 0.3.4'
+  s.add_dependency 'logcabin', '~> 0.0.1'
 
   s.add_development_dependency 'rubocop', '~> 0.35.0'
   s.add_development_dependency 'rake', '~> 10.4.0'
   s.add_development_dependency 'codecov', '~> 0.1.1'
   s.add_development_dependency 'rspec', '~> 3.4.0'
   s.add_development_dependency 'fuubar', '~> 2.0.0'
-  s.add_development_dependency 'webmock', '~> 1.22.0'
-  s.add_development_dependency 'vcr', '~> 3.0.0'
 end

data/spec/prospectus_spec.rb

@@ -1,2 +1 @@
 require 'spec_helper'
-

metadata

@@ -1,116 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: prospectus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: mercenary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.0
-  type: :development
+        version: 0.3.4
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.0
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: logcabin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.0
-  type: :development
+        version: 0.0.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.0
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.35.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.35.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 10.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 10.4.0
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
-description: DSL and tool for checking for state changes
+        version: 2.0.0
+description: Tool and DSL for checking expected vs actual state
 email: me@lesaker.org
-executables: []
+executables:
+- prospectus
 extensions: []
 extra_rdoc_files: []
 files:
@@ -121,8 +122,22 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/prospectus
 - circle.yml
 - lib/prospectus.rb
+- lib/prospectus/helpers/github_api.rb
+- lib/prospectus/helpers/regex.rb
+- lib/prospectus/item.rb
+- lib/prospectus/list.rb
+- lib/prospectus/modules/gemnasium.rb
+- lib/prospectus/modules/git_tag.rb
+- lib/prospectus/modules/github_release.rb
+- lib/prospectus/modules/github_tag.rb
+- lib/prospectus/modules/grep.rb
+- lib/prospectus/modules/static.rb
+- lib/prospectus/modules/url_xpath.rb
+- lib/prospectus/state.rb
+- lib/prospectus/version.rb
 - prospectus.gemspec
 - spec/prospectus_spec.rb
 - spec/spec_helper.rb
@@ -146,10 +161,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: DSL and tool for checking for state changes
+summary: Tool and DSL for checking expected vs actual state
 test_files:
 - spec/prospectus_spec.rb
 - spec/spec_helper.rb