prospectus 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1e57758125416af8b0991ea4f0adcd9d7bf79aa
-  data.tar.gz: 1c303beb9ac103bcc132ea91193fe80bcb51be3d
+  metadata.gz: 67fdaf9d85016c56745670bc3950906d07288129
+  data.tar.gz: d764a11f127a12a2ecc22f43f27fd5270dbb792a
 SHA512:
-  metadata.gz: ce04a20517ccbbce7673b0cd51257b09146f6ed8d714810a62679fdd0ce72c2fe5aff430bac80b5da59b2990da92882f6f051cb061b1e30a7df84c947d66aa47
-  data.tar.gz: a289be38450677643b3ae5f4832899457658a7f3945f16e24548cb80c70e7a54f85c386a9e52797446ba0b91e3be0969a2660345f60a360c8a4776811eafecb6
+  metadata.gz: 78411e2c4e76f03c02b7c0487b60289c3be11bf74d2b1de02e6071303632c728eb83e13a514ae34d257b46302862facd4fb2335753b85a2f2266550dac7babde
+  data.tar.gz: 1a396dd894814191fb051b1c188f50aca8c3ca51e78c8ec01c8c9903a01d3f0967c022cdc860ef67af0b8cf80f235b8db7708e2d8a18bee36b5c290bf56cf9bd

data/README.md

@@ -41,9 +41,134 @@ To run the check, just run `prospectus` in the directory with the .prospectus fi
 
 ## Included Modules
 
-### static_test
+The following modules are included with Prospectus.
 
-Used for testing, this allows you to manually declare a state:
+Most of the examples below will use either an expected or actual block, based on the most common use case, but any module can be used for either state.
+
+### git_tag
+
+This checks the git tag of the local repo. Supports the Regex helper
+
+```
+# This would use the current git tag directly
+actual do
+  git_tag
+end
+```
+
+```
+# This would convert v1.0.0 into 1.0.0
+actual do
+  git_tag
+  regex /^v([\d.]+)$/
+end
+```
+
+```
+# And this would convert v1_0_0 into 1.0.0
+actual do
+  git_tag
+  regex /^v(\d+)_(\d+)_(\d+)$/, '\1.\2.\3'
+end
+```
+
+### git_hash
+
+Checks the git hash of a local repository. Supports the chdir helper.
+
+Will return the short hash unless the `long` argument is provided.
+
+Primarily used for checking git submodules.
+
+```
+# Returns the short hash
+actual do
+  git_hash
+  dir 'submodules/my-important-other-repo'
+end
+
+# Returns the full hash
+actual do
+  git_hash
+  long
+  dir 'submodules/other-repo'
+end
+```
+
+### github_release
+
+This checks the latest GitHub release for a repo (must be a real Release, not just a tag. Use github_tag if there isn't a Release). Supports the Regex helper and uses the GitHub API helper for API access.
+
+```
+expected do
+  github_release
+  repo 'amylum/s6'
+end
+```
+
+### github_tag
+
+This checks the latest GitHub tag for a repo. Supports the Regex helper and uses the GitHub API helper for API access.
+
+```
+expected do
+  github_tag
+  repo 'reubenhwk/radvd'
+end
+```
+
+### grep
+
+This checks a local file's contents. Supports the Regex helper, and uses the provided regex pattern to match which line of the file to use. If no regex is specified, it will use the full first line of the file.
+
+```
+# Searches file for OPENSSL_VERSION = 1.0.1e and returns 1.0.1e
+actual do
+  grep
+  file 'Makefile'
+  regex /^OPENSSL_VERSION = ([\w.-]+)$/
+end
+```
+
+### url_xpath
+
+Used to parse an xpath inside a web page. Requires the nokogiri gem, and supports the Regex helper.
+
+The easiest way to get an xpath is usually to use Chrome's Inspector to find the element you want and right click it -> Copy -> As XPath. There are some quirks, notably that nokogiri doesn't parse the tbody tag (just remove it from the xpath that Chrome provides).
+
+```
+# Parses the latest tag for procps-ng
+expected do
+  url_xpath
+  url 'https://gitlab.com/procps-ng/procps/tags'
+  xpath '/html/body/div[1]/div[2]/div[2]/div/div/div[2]/ul/li[1]/div[1]/a/strong/text()'
+  regex /v([\d.]+)$/
+end
+```
+
+### gemnasium
+
+Parses the dep status on Gemnasium for a project. Will return the worst color from their dashboard (red, yellow, or green). Requires the netrc gem.
+
+Due to the nature of the response, this is best used with a `static` expected block, like this:
+
+```
+item do
+  expected do
+    static
+    set 'green'
+  end
+
+  actual do
+    gemnasium
+    slug 'amylum/server'
+  end
+end
+```
+
+### static
+
+Basic module for staticly defining a value. Useful for testing, and also for comparisons against a known state (like with the gemnasium module).
 
 ```
 item do
@@ -58,6 +183,45 @@ item do
 end
 ```
 
+## Included Helpers
+
+### regex
+
+Allows modification of result using regex. Supported by most modules, per the above modules list.
+
+The first argument should be a regex pattern to match against the value. Note that an error will be raised if the value does not match the provided regex. An optional second value specifies the replacement string to use; the default is '\1', which will use the first capture group from your regex.
+
+```
+# This would convert v1.0.0 into 1.0.0
+actual do
+  git_tag
+  regex /^v([\d.]+)$/
+end
+```
+
+```
+# And this would convert v1_0_0 into 1.0.0
+actual do
+  git_tag
+  regex /^v(\d+)_(\d+)_(\d+)$/, '\1.\2.\3'
+end
+```
+
+### chdir
+
+Used to chdir to a different directory before loading the state.
+
+```
+actual do
+  git_hash
+  dir 'submodules/important_repo'
+end
+```
+
+### github_api
+
+Used by modules to provide authenticated access to the GitHub API. Uses the [octoauth gem](https://github.com/akerl/octoauth)
+
 ## Installation
 
     gem install prospectus

data/lib/prospectus/helpers/chdir.rb

@@ -0,0 +1,18 @@
+module LogCabin
+  module Modules
+    ##
+    # Change directory before running module
+    module Chdir
+      def chdir_helper(&block)
+        @dir ||= '.'
+        Dir.chdir(@dir) { block.call }
+      end
+
+      private
+
+      def dir(value)
+        @dir = value
+      end
+    end
+  end
+end

data/lib/prospectus/modules/git_hash.rb

@@ -0,0 +1,24 @@
+module LogCabin
+  module Modules
+    ##
+    # Pull state from a git hash
+    module GitHash
+      include Prospectus.helpers.find(:chdir)
+
+      def load!
+        chdir_helper do
+          short_arg = @long ? '' : '--short'
+          hash = `git rev-parse #{short_arg} HEAD 2>/dev/null`.chomp
+          fail('No hash found') if hash.empty?
+          @state.value = hash
+        end
+      end
+
+      private
+
+      def long
+        @long = true
+      end
+    end
+  end
+end

data/lib/prospectus/modules/grep.rb

@@ -7,6 +7,7 @@ module LogCabin
 
       def load!
         fail('No file specified') unless @file
+        @find ||= '.*'
         line = read_file
         @state.value = regex_helper(line)
       end

data/lib/prospectus/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prospectus
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Les Aker
@@ -125,11 +125,13 @@ files:
 - bin/prospectus
 - circle.yml
 - lib/prospectus.rb
+- lib/prospectus/helpers/chdir.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_hash.rb
 - lib/prospectus/modules/git_tag.rb
 - lib/prospectus/modules/github_release.rb
 - lib/prospectus/modules/github_tag.rb