fixman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dff2cf3e7e6c5dc503e797509e4cca24b94090cc
+  data.tar.gz: 9a497dbd95d32ca095de23fbddff918de7e680d3
+SHA512:
+  metadata.gz: 82f54fc14ae20ccbfd6effd0d4edb15db717f4cc246291f3ee1bbb0aa0d2a66da387cbf412000825bedbed23f64e5763c05856d0c15fa244f08eb6c5bfd3fafe
+  data.tar.gz: a4883f1d8f7bb1e4d1d1c2246b86b930e78827eb2b1c39fe482bce6621910c352ce0172d4779a2983ac30f6cbe7a6bd4837bd9bec965791e772cb8b56b4b877a

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2015-10-02
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,23 @@
+History.txt
+Manifest.txt
+README.md
+Rakefile
+bin/fixman
+lib/fixman.rb
+lib/fixman/configuration.rb
+lib/fixman/command_line.rb
+lib/fixman/controller.rb
+lib/fixman/raw_task.rb
+lib/fixman/repository.rb
+lib/fixman/task.rb
+lib/fixman/task_parse_error.rb
+lib/fixman/tester.rb
+lib/fixman/utilities.rb
+test/test_fixman.rb
+test/test_command_line.rb
+test/test_configuration.rb
+test/test_controller.rb
+test/test_raw_task.rb
+test/test_repository.rb
+test/test_task.rb
+test/test_tester.rb

data/README.md

@@ -0,0 +1,176 @@
+# fixman
+
+home  :: https://github.com/madgen/fixman
+
+## DESCRIPTION:
+
+THIS PROJECT IS NOT YET READY FOR USAGE!
+
+A tool to test source code analysis command line tools against source code
+remotely available in git repositories such as GitHub.
+
+## FEATURES/PROBLEMS:
+
+## COMMAND LINE
+
+### test
+
+`fixman <test>`
+
+### list/shortlist
+
+`fixman <list|shortlist>`
+
+Lists the repositories used in testing. Shortlist succint summary
+of the repositories with canonical name and commit hash used for
+testing.
+
+### add
+
+`fixman <add>`
+Starts interactive session to add new repository with the details.
+
+### delete
+
+`fixman <delete> <canonical_name>`
+
+Delete the repository identified by its canonical name from the list of places
+to be tested.
+
+### fetch
+
+`fixman <fetch> [group...]`
+
+Download all the repositories belonging to list of groups. The groups would be
+specified in the configuration file. If group is left out all repositories are
+fetched.
+
+The version of the repository fetch is set to HEAD by default. If a different
+commit is desired this can be specified while adding the repository or by
+altering the YAML file containing the repositories.
+
+If the remote repository cannot be reached or there are not sufficient
+priveleges, fetch process skips to the next repository but produces a
+warning.
+
+### update
+
+`fixman <update> <canonical_name> [commit_SHA]`
+
+Updates the commit of the repository. This can be a future commit or an older
+one. It only updates the repository listing as such `upgrade` needs to be run to
+update the repo in the file system.
+
+### upgrade
+
+`fixman <upgrade> <group(s)>`
+
+## CONFIGURATION FILE
+
+Configuration file is a YAML file ordinarily located at `.fixman_conf.yaml`
+unless it has been overridden by the `-c` command line option. It contains
+task definitions, base path for the fixtures, and allows overriding various
+defaults.
+
+### Fixture base (compulsory)
+
+The base path for repositories listed in the ledger.
+
+Example
+
+```
+:fixture_base: /path/to/base_dir
+```
+
+### Task definitions (compulsory)
+
+An array of tasks to be run on the repositories specified in the fixtures
+ledger.
+
+Example:
+
+```
+:tasks:
+  - :target_condition: :ruby: 2.even?
+    :command:
+    :extra_placeholders:
+    :cleanups:
+    :target_placeholder:
+```
+
+### Extra repository information (optional)
+
+If set, it causes `add` command to direct more queries to the user than what
+is necessary for fixman to function. This information can be things like notes,
+licence, urls, and anything else. It further allows these fields to be optional,
+chosen from set values, or mandatory.
+
+Each extra repository information has the following subfields
+
+#### Symbol (mandatory)
+Unique symbol for the extra bit of information.
+
+#### Prompt (mandatory)
+Prompt directed at the user when `add` command is used.
+
+#### Label (mandatory)
+Label to be used when the repositories are listed for this information.
+
+#### Choices (optional)
+A list of strings corresponding to choices the value of the field can take.
+
+#### Optional (optional)
+If set to true, then the empty entry is acceptable. If omitted or set to false
+the prompt is repeated until a valid input is received.
+
+Example:
+
+```
+:extra_repo_info:
+  - :symbol:    licence
+    :prompt:    Please enter licence
+    :label:     Licence
+    :choices:   [MIT, Apache, GPL]
+
+  - :symbol:    notes
+    :prompt:    Any notes?
+    :label:     Notes
+    :optional:  true
+```
+
+### Groups (optional)
+
+Not every repository in the ledger needs to be fetched and tested. This option
+allows user to specify groups which can be separately fetched and tested. Refer
+to the command line documentation for example usage.
+
+Example:
+
+```
+:groups: [:public, :private]
+```
+
+### Fixture ledger (optional)
+
+The path to the YAML file that acts as a ledger for the repositories. Defaults
+to `.fixman_ledger.yaml`.
+
+Example:
+
+```
+:fixture_ledger: /path/to/my_ledger.yaml
+```
+
+## REQUIREMENTS:
+
+Requires Ruby 1.9.3 or onwards.
+
+## INSTALL:
+
+`gem install fixman`
+
+## LICENSE
+
+Refer to LICENCE file but it is basically Apache Licence v2.0.
+
+Copyright 2015 Mistral Contrastin

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :minitest
+Hoe.plugin :git
+Hoe.plugin :gemspec
+
+Hoe.spec 'fixman' do
+  developer("Mistral Contrastin", "madgenhetic@gmail.com")
+  self.readme_file = 'README.md'
+
+  dependency 'classy_hash', '~> 0.1'
+  dependency 'git', '~> 1.2'
+  dependency 'pry-byebug', '~> 1.2', :dev
+
+  license 'Apache'
+end

data/bin/fixman

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'fixman'
+
+include Fixman::CommandLine
+include Fixman::Utilities 
+
+options = parse_options!(ARGV)
+command, args = parse_positional_arguments!(ARGV)
+conf = Fixman::Configuration.read options[:conf_path]
+
+case command
+when :test
+  tester = Fixman::Tester.new conf
+  tester.test
+when [:list, :shortlist]
+  repos = Fixman::Controller.open conf do |controller|
+    controller.repos
+  end
+
+  puts(command == :list ? repos : repos.map(&:summary))
+when :add
+  params = get_params conf.extra_repo_info, conf.groups
+
+  Fixman::Controller.open conf do |controller|
+    controller.add params, conf.fixtures_base, conf.extra_repo_info
+  end
+when :delete
+  Fixman::Controller.open conf do |controller|
+    begin
+      controller.delete args[:canonical_name]
+    rescue ArgumentError
+      error "Input #{args[:canonical_name]} is not a valid canonical \
+        repository name."
+    end
+  end
+when :fetch
+  Fixman::Controller.open conf do |controller|
+    controller.fetch args[:groups]
+  end
+when :update
+  Fixman::Controller.open conf do |controller|
+    update_args = [args[:canonical_name], args[:sha]].compact
+    controller.update(*update_args)
+  end
+when :upgrade
+  Fixman::Controller.open conf do |controller|
+    controller.upgrade args[:groups]
+  end
+end

data/lib/fixman.rb

@@ -0,0 +1,13 @@
+require 'fixman/configuration'
+require 'fixman/command_line'
+require 'fixman/controller'
+require 'fixman/raw_task'
+require 'fixman/repository'
+require 'fixman/task'
+require 'fixman/task_parse_error'
+require 'fixman/tester'
+
+module Fixman
+  VERSION = '0.1.0'
+  NAME = 'fixman'
+end

data/lib/fixman/command_line.rb

@@ -0,0 +1,184 @@
+require 'optparse'
+require 'pathname'
+require 'set'
+require 'fixman/utilities'
+require 'fixman/configuration'
+
+module Fixman
+  module CommandLine
+
+    URL_TEMPLATE = {
+      symbol: :url,
+      prompt: 'Remote repository URL: ',
+      label: 'URL',
+      type: :mandatory
+    }
+
+    NAME_TEMPLATE = {
+      symbol: :name,
+      prompt: 'Repository name: ',
+      label: 'Name',
+      type: :mandatory
+    }
+
+    OWNER_TEMPLATE = {
+      symbol: :owner,
+      prompt: 'Owner: ',
+      label: 'Owner',
+      type: :mandatory
+    }
+
+    GROUPS_TEMPLATE = {
+      symbol: :groups,
+      prompt: 'Groups: ',
+      label: 'Groups',
+      type: :multiple_choice
+    }
+
+    include Utilities
+
+    def parse_options!(args)
+      options = {}
+      options[:conf_path] =
+        Pathname.new Fixman::Configuration::DEFAULT_CONF_FILE
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{NAME} [option]"
+
+        opts.on_tail('-h', '--help', 'Display this message') do
+          puts 'help' # TODO
+          exit 0
+        end
+
+        opts.on('-v', '--version', 'Display the version') do
+          puts VERSION
+          exit 0
+        end
+
+        opts.on('-c', '--configuration-file PATH') do |path|
+          options[:conf_path] = Pathname.new path
+        end
+      end
+
+      begin
+        parser.parse! args
+      rescue OptionParser::InvalidaOption
+        error usage
+      end
+
+      options
+    end
+
+    # Options are parsed prior to the positional arguments allowing
+    # optional trailing positional arguments.
+    def parse_positional_arguments!(raw_args)
+      # Error if there are no commands
+      error usage if raw_args.size < 1
+
+      command = raw_args.shift.downcase.to_sym
+      args = {}
+
+      case command
+      when :test, :list, :shortlist, :add
+        error usage unless raw_args.size == 0
+      when :delete
+        error usage unless raw_args.size == 1
+        args[:canonical_name] = raw_args.shift
+      when :fetch, :upgrade
+        args[:groups] = raw_args.map { |group| group.downcase.to_sym }
+        raw_args.delete_if {true}
+      when :update
+        error usage unless [1, 2].include? raw_args.size
+        args[:canonical_name], args[:sha] = raw_args.shift 2
+      else
+        error usage
+      end
+
+      [command, args]
+    end
+
+    def get_params extra_templates, groups
+      input = {}
+      start_session input, URL_TEMPLATE
+
+      input[:owner], input[:name] =
+        Fixman::Repository.extract_owner_and_name input[:url]
+      unless input[:owner] && input[:name]
+        start_session input, NAME_TEMPLATE
+        start_session input, OWNER_TEMPLATE
+      end
+
+      unless groups.empty?
+        GROUPS_TEMPLATE[:choices] = groups
+        start_session input, GROUPS_TEMPLATE
+      end
+
+      extra_templates.each do |template|
+        start_session input, template
+      end
+
+      input[:sha] = Repository.retrieve_head_sha input[:url]
+
+      input
+    end
+
+    def usage
+      #TODO
+    end
+
+    private
+
+    def start_session input, template
+      raw_input = nil
+      case template[:type]
+      when :mandatory
+        loop do
+          print template[:prompt]
+          raw_input = get_input
+          break unless raw_input =~ /^\s*$/
+        end
+      when :optional, nil # nil in the case type is not specified
+        print template[:prompt]
+        raw_input = get_input
+      when :single_choice
+        loop do
+          puts template[:prompt]
+          print "Choose one from #{template[:choices].join('/')}: "
+          raw_input = get_input
+          choice_index =
+            template[:choices].map(&:downcase).find_index raw_input.strip.downcase
+          if choice_index
+            raw_input = template[:choices][choice_index]
+            break
+          end
+        end
+      when :multiple_choice
+        choices = template[:choices].map(&:strip)
+        downcase_choices = choices.map(&:downcase)
+        loop do
+          puts template[:prompt]
+          print "Comma separated multiple choice #{template[:choices].join('/')}: "
+          raw_input = get_input.split(',').map(&:strip)
+          raw_choices = raw_input.map(&:downcase).to_set
+
+          if raw_choices.subset? downcase_choices.to_set
+            raw_input =
+            raw_choices.inject([]) do |acc, choice|
+              i = downcase_choices.find_index choice
+              acc << choices[i]
+            end
+            break
+          end
+        end
+      else
+        # TODO error behaviour
+      end
+
+      input[template[:symbol]] = raw_input
+    end
+
+    def get_input
+      gets.chomp
+    end
+  end
+end