jdepp 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96527f280981167b06226e29d5d4ad28184bfa0a
+  data.tar.gz: acc1201002bfab7b5d7ba31a815168a91dd2992d
+SHA512:
+  metadata.gz: c24fcfaa1a0f5d15aca5e9704746ba94526c395e4e57cf3e98c85b69af464b6b47b927e639a188e5d0072577a0a64f41d99ff526e607c9ad9a1427b64305a40f
+  data.tar.gz: 80f0a310b9418d9fe1256dbc6ed6102e0be0eddc1436bfef46e6332f32dca703abd461c9c37b3bc692897ee459730eff4d13d3aeeb24100f269e7c5e288160ce

data/.gitignore

@@ -0,0 +1,21 @@
+*.swp
+/bin/
+/_vendor/
+
+# provided by bundler
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+# -----
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jdepp.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 michael lowell roberts
+
+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,33 @@
+# the jaunty dependency preprocessor
+
+this is a small utility that scans source files for dependency declarations. currently, it only supports [f*](http://fstar-lang.org).
+
+## installation
+
+add this line to your application's Gemfile:
+
+```ruby
+gem "jdepp", :git => "https://github.com/fmrl/jdepp.git"
+```
+
+and then execute:
+
+    $ bundle
+
+<!--
+or install it yourself as:
+
+    $ gem install jdepp
+-->
+
+## usage
+
+documentation doesn't really exist yet but you can type `bundle exec jdepp` to see what documentation exists.
+
+## contributing
+
+1. fork it ( https://github.com/fmrl/jdepp/fork )
+2. create your feature branch (`git checkout -b my-new-feature`)
+3. commit your changes (`git commit -am 'Add some feature'`)
+4. push to the branch (`git push origin my-new-feature`)
+5. create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/jdepp.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jdepp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jdepp"
+  spec.version       = Jdepp::VERSION
+  spec.authors       = ["michael lowell roberts"]
+  spec.email         = ["mlr@fmrl.org"]
+  spec.summary       = %q{a language-independent scanner for build utilities.}
+#  spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "https://github.com/fmrl/jdepp.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/jdepp/cli/feedback.rb

@@ -0,0 +1,95 @@
+require "pp"
+require "set"
+
+module Jdepp
+   module CLI
+
+      class Feedback
+         attr_reader :enabled_tags
+         attr_reader :output
+
+         def initialize(enabled_tags=[], output=$stderr)
+            @enabled_tags = Set.new([:error]) | enabled_tags
+            @output = output
+         end
+
+         def add_tag(tag)
+            @enabled_tags.add(tag)
+         end
+         
+         def delete_tag(tag)
+            @enabled_tags.delete(tag)
+         end
+
+         def dry_run?
+            @enabled_tags.member?(:dry_run)
+         end
+
+         def dry_run
+            add_tag(:dry_run)
+         end
+
+         def verbose?
+            @enabled_tags.member?(:verbose)
+         end
+
+         def verbose
+            add_tag(:verbose)
+         end
+
+         def action?
+            @enabled_tags.member?(:action)
+         end
+
+         def action
+            add_tag(:action)
+         end
+
+         def quiet
+            preserve_dry = dry_run
+            @enabled_tags = Set.new([:error])
+            if preserve_dry then
+               dry_run
+            end
+         end
+
+         def puts_if(relevant_tags, &msg)
+            if relevant_tags.is_a?(Array) then
+               relevant_tags = Set.new(relevant_tags)
+            elsif not relevant_tags.is_a?(Set) then
+               relevant_tags = Set.new([relevant_tags])
+            end
+            tags = relevant_tags.intersection(@enabled_tags)
+            if tags.length > 0 then
+               @output.puts("#{prefix tags}#{msg.call()}")
+            end
+            nil
+         end
+
+         def system(cmds)
+            puts_if([:dry_run, :verbose, :action]) { cmds }
+            if not self.dry_run? then
+               Kernel::system(cmds)
+            else
+               nil
+            end
+         end
+
+         private
+
+         def prefix(relevant_tags)
+            if relevant_tags.empty? then
+               raise "i cannot create a feedback from an empty tag set."
+            end
+            tags = (relevant_tags.map {|tag| tag.to_s}).sort
+            # todo: refactor to reduce
+            result = ""
+            tags[0..-2].each {|s| result += "#{s}, "}
+            result += "#{tags[-1]}: "
+            result
+         end
+
+      end
+   end
+end
+

data/lib/jdepp/cli.rb

@@ -0,0 +1,112 @@
+require "jdepp/cli/feedback"
+require "jdepp/parser"
+
+require "optparse"
+require 'rbconfig'
+
+module Jdepp::CLI
+
+   def self.cli(argv)
+
+      opts = {:feedback => Feedback.new([:action]), :locations => {}}
+
+      end_of_options = argv.index("--")
+      opts[:stdout] = end_of_options.nil?
+      if not opts[:stdout] then
+         if argv.length > 0 then
+            opts[:recipient] = argv[end_of_options + 1..-1].join(" ")
+         end
+         argv = ARGV.first(end_of_options)
+      end
+
+      OptionParser.new do 
+         |o|
+         o.banner = "usage: jdepp.rb [options] FILE [FILE ...] [-- COMMAND]"
+         o.on("-v", "--[no-]verbose", "i will provide extra detail about my activity.") do
+            |v|
+            if (v) then
+               opts[:feedback].add_tag(:verbose)
+            end
+         end
+         o.on("-n", "--[no-]dry-run", "i will report what i would do if i were to perform the specified work.") do
+            |flag|
+            if (flag) then
+               opts[:feedback].add_tag(:dry_run)
+            end
+         end
+         o.on("-q", "--quiet", "i will suppress as much commentary as possible.") do
+            |flag|
+            if (flag) then
+               opts[:feedback].quiet
+            end
+         end
+         o.on("-D", "--define=LOCATION", 'if provided with a specification of the form "PREFIX=PATH", i will substitute PREFIX: for PATH if encountered.') do
+            |s|
+            name, path = s.split("=", 2)
+            opts[:locations][name] = Pathname.new(path)
+         end
+         o.on("-F","--feedback-tags=TAGS", "i will provide feedback related to the specified tags") do
+            |tag_list|
+            tags = tag_list.split(",")
+            tags.each {|t| opts[:feedback].add_tag(t.to_sym)}
+         end
+         o.on("-a","--[no-]append-dependents", "i will append the dependents to the list of dependencies") do
+            |flag|
+            opts[:append_dependents] = flag
+         end
+         o.on("--[no-]trace", "i will show the ruby callstack should an exception occur.") do
+            |flag|
+            opts[:trace] = flag
+         end
+      end.parse!(argv)
+
+      if opts.fetch(:trace, false) then
+         parse(argv, opts)
+      else
+         begin
+            parse(argv, opts)
+         rescue Exception => e
+            opts[:feedback].puts_if([:error]) {e.message}
+         end
+      end
+
+   end
+
+   private
+
+   def self.parse(argv, opts)
+      is_windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
+
+      parser = Jdepp::Parser.new(opts[:locations], opts[:feedback])
+      result = parser.parse(argv)
+      if opts.fetch(:append_dependents, false) then
+         result.concat(argv)
+      end
+
+      if opts[:stdout] then
+         if result.length == 0 then
+            $stderr.puts "i have an empty result-- is this what you intended?\n"
+         else
+            puts result
+         end
+      elsif not opts.fetch(:recipient, nil).nil? then
+         # todo: thread the exit status through
+         if is_windows then
+             result.map! {|s| if s.include? ' ' then '"%s"' % s else s end}
+         end
+         opts[:feedback].system "#{opts[:recipient]} #{result.join(' ')}"
+      else
+         $stderr.puts "i have nothing to do!"
+      end
+   end
+
+end
+
+
+
+
+
+
+
+
+

data/lib/jdepp/parser.rb

@@ -0,0 +1,60 @@
+require "pathname"
+require "pp"
+require "set"
+
+module Jdepp
+
+   class Parser
+
+      def initialize(locations={}, feedback=Feedback.new)
+         @locations = locations
+         @feedback = feedback
+      end
+
+      def parse(file_list)
+
+         def recurse(accum, path)
+            re = /^\/\/\s*@requires\s*"(([^"\n:]+):)?([^"\n]+)"\s*$/
+            lines = File.readlines(path.to_s)
+            lines.reduce(accum) do
+               |a, ln|
+               matches = re.match(ln)
+               if matches != nil then
+                  if matches[1].nil? then
+                     rel = Pathname.new(path.dirname + matches[3])
+                  else
+                     loc_alias = matches[2]
+                     if @locations.key?(loc_alias) then
+                        rel = @locations[loc_alias].join(matches[3])
+                     else
+                        # todo: convert path to relative path.
+                        raise "i don't recognize the location alias \"#{loc_alias}\" encountered in <#{path}>."
+                     end
+                  end
+                  if not rel.exist? then
+                     raise "i can't find #{rel.to_s} (required by #{path})."
+                  end
+                  abs = rel.realdirpath
+                  if not a.key?(abs) then
+                     @feedback.puts_if(:verbose) {"i matched #{rel} (#{abs})"}
+                     recurse(a, rel)
+                     a[abs] = rel
+                  else
+                     @feedback.puts_if(:verbose) {"i am ignoring a duplicate directive for #{rel} (#{abs})"}
+                  end
+               end
+               a
+            end
+         end
+
+         # todo: default to returning relative paths; absolute on request.
+         (file_list.reduce({}) do
+            |accum, s|
+            recurse(accum, Pathname.new(s))
+            accum
+         end).values.map {|p| p.to_s}
+      end
+
+   end
+
+end

data/lib/jdepp/version.rb

@@ -0,0 +1,3 @@
+module Jdepp
+  VERSION = "0.2.1"
+end

data/lib/jdepp.rb

@@ -0,0 +1,6 @@
+require "jdepp/version"
+require "jdepp/cli"
+
+module Jdepp
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: jdepp
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- michael lowell roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- mlr@fmrl.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jdepp.gemspec
+- lib/jdepp.rb
+- lib/jdepp/cli.rb
+- lib/jdepp/cli/feedback.rb
+- lib/jdepp/parser.rb
+- lib/jdepp/version.rb
+homepage: https://github.com/fmrl/jdepp.git
+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.2.2
+signing_key: 
+specification_version: 4
+summary: a language-independent scanner for build utilities.
+test_files: []