shanty 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 472f2d824a07db1b5c47ec13ddca184cad7478db
-  data.tar.gz: 6a45c1b9a654584efbd06d87d2c7202667095b43
+  metadata.gz: c1dc7e7d6baa3b74a90fb389dee1d33fc8959af0
+  data.tar.gz: 597c9fa320428c48c3ca7e100048e7fdb50a982b
 SHA512:
-  metadata.gz: 92abe04b4e6d65338f17a637c03ff0079297b3777c3e23726d4d8f85438121ece70a02806feac64e149e24103816f734518247e6f07ee53c460b0778a802b31a
-  data.tar.gz: 7b7e75add8f40176c1510ffeb96453678194a8e4f7f6a6fafb9f266d1e3a211d00d5d144285ee50d72ebd0e63d8c3276d9931d6017121705ca2ab8b2feecf3f0
+  metadata.gz: ab037eae56ab017500c24a0b3e23e178763953736e43a115201851aefba6f38b009c77638281608bdb2c8181d035049ac1ef136a2fb1fe1fd2a99fa38acb1b66
+  data.tar.gz: 43122c363848e085b35dcbd76956a0e51127ff9ebf38bdeaac49b81138a4d42a1e78a9bd5859bd38d66d3383d27811254b0c152180b5a6b771fc9af176fdc905

data/README.md

@@ -1,4 +1,4 @@
-# Shanty [![Build Status](https://travis-ci.org/shantytown/shanty.svg?branch=master)](https://travis-ci.org/shantytown/shanty)[![Coverage Status](https://coveralls.io/repos/shantytown/shanty/badge.png?branch=master)](https://coveralls.io/r/shantytown/shanty?branch=master)
+# Shanty [![Build Status](https://travis-ci.org/shantytown/shanty.svg?branch=master)](https://travis-ci.org/shantytown/shanty) [![Coverage Status](https://coveralls.io/repos/shantytown/shanty/badge.png?branch=master)](https://coveralls.io/r/shantytown/shanty?branch=master)
 
 **Shanty** is a project orchestration tool. It is designed to make it easy for you to build dependencies between projects, and execute tasks across this tree of relationships, regardless of what language or technology these projects use. The aim is consistency in the way you manage, build, test and deploy your projects.
 
@@ -31,7 +31,7 @@ We welcome any contribution, whether big or small! We're busy importing our plan
 
 The MIT License (MIT)
 
-Copyright (c) 2014 Chris Jansen, Nathan Kleyn
+Copyright (c) 2015 Chris Jansen, Nathan Kleyn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/shanty.rb

@@ -4,23 +4,27 @@ require 'pry'
 
 require 'shanty/cli'
 require 'shanty/discoverers/shantyfile'
+require 'shanty/discoverers/rubygem'
+require 'shanty/env'
 require 'shanty/graph'
-require 'shanty/global'
-require 'shanty/mutators/git'
-require 'shanty/tasks/basic'
+require 'shanty/mutators/bundler'
+require 'shanty/mutators/changed'
+require 'shanty/plugins/rspec'
+require 'shanty/plugins/rubocop'
+require 'shanty/task_env'
+require 'shanty/task_sets/basic'
 
 module Shanty
   # Main shanty class
   class Shanty
+    # This is the root directory where the Shanty gem is located. Do not confuse this with the root of the repository
+    # in which Shanty is operating, which is available via the TaskEnv class.
     GEM_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 
     def start!
       setup_i18n
-      Cli.new(graph).run
-    end
 
-    def graph
-      @graph ||= construct_project_graph
+      Cli.new(TaskEnv.new(Env.new)).run
     end
 
     private
@@ -29,19 +33,5 @@ module Shanty
       I18n.enforce_available_locales = true
       I18n.load_path = Dir[File.join(GEM_ROOT, 'translations', '*.yml')]
     end
-
-    def construct_project_graph
-      project_templates = Dir.chdir(Global.root) do
-        Discoverer.new.discover_all
-      end
-
-      projects = project_templates.map do |project_template|
-        project_template.type.new(project_template)
-      end
-
-      graph = Graph.new(projects)
-
-      Mutator.new.apply_mutations(graph)
-    end
   end
 end

data/lib/shanty/cli.rb

@@ -1,6 +1,6 @@
 require 'commander'
 require 'i18n'
-require 'shanty/task'
+require 'shanty/task_set'
 
 module Shanty
   # Public: Handle the CLI interface between the user and the registered tasks
@@ -8,13 +8,13 @@ module Shanty
   class Cli
     include Commander::Methods
 
-    def initialize(graph)
-      @graph = graph
+    def initialize(task_env)
+      @task_env = task_env
     end
 
     def tasks
-      Task.tasks.reduce({}) do |acc, task|
-        acc.merge(task.task_definitions)
+      TaskSet.task_sets.reduce({}) do |acc, task_set|
+        acc.merge(task_set.tasks)
       end
     end
 
@@ -36,28 +36,44 @@ module Shanty
     end
 
     def setup_task(name, task)
-      command name do |c|
+      command(name) do |c|
         c.description = I18n.t(task[:desc], default: task[:desc])
+        c.syntax = task[:syntax]
+        add_options_to_command(task, c)
+        add_action_to_command(name, task, c)
+      end
+    end
 
-        task[:options].each do |option_name, option|
-          c.option(syntax_for_option(option_name, option), I18n.t(option[:desc], default: option[:desc]))
-        end
+    def add_options_to_command(task, command)
+      task[:options].each do |option_name, option|
+        command.option(syntax_for_option(option_name, option), I18n.t(option[:desc], default: option[:desc]))
+      end
+    end
 
-        c.action do |args, options|
-          execute_task(name, args, options)
-        end
+    def add_action_to_command(name, task, command)
+      command.action do |args, options|
+        task = tasks[name]
+        options.default(Hash[defaults_for_options(task)])
+        execute_task(name, task, args, options)
       end
     end
 
-    def execute_task(name, args, options)
-      task = tasks[name]
+    def execute_task(name, task, args, options)
+      # We use allocate here beccause we do not want this to blow up because the class defines a constructor.
+      # We cannot and do not support taskset classes needing constructors.
+      klass = task[:klass].allocate
+      arity = klass.method(name).arity
 
-      default_option_pairs = task[:options].map do |option_name, option|
+      args.unshift(@task_env) if arity >= 2
+      args.unshift(options) if arity >= 1
+
+      klass.send(name, *args)
+    end
+
+    def defaults_for_options(task)
+      task[:options].map do |option_name, option|
         [option_name, default_for_type(option)]
       end
-      options.default(Hash[default_option_pairs])
-
-      task[:klass].new.send(name, options, @graph, *args)
     end
 
     def syntax_for_option(name, option)
@@ -65,7 +81,7 @@ module Shanty
                when :boolean
                  "--#{name}"
                else
-                 "--#{name} #{option[:type].upcase}"
+                 "--#{name} #{(option[:type] || 'string').upcase}"
                end
 
       option[:required] ? "[#{syntax}]" : syntax

data/lib/shanty/discoverer.rb

@@ -10,6 +10,12 @@ module Shanty
       attr_reader :discoverers
     end
 
+    attr_reader :env
+
+    def initialize(env)
+      @env = env
+    end
+
     def self.inherited(discoverer)
       Util.logger.debug("Detected project discoverer #{discoverer}")
       @discoverers ||= []
@@ -18,14 +24,14 @@ module Shanty
 
     def discover_all
       self.class.discoverers.flat_map do |discoverer|
-        discoverer.new.discover
+        discoverer.new(env).discover
       end
     end
 
     private
 
-    def create_project(*args)
-      ProjectTemplate.new(*args)
+    def create_project_template(*args)
+      ProjectTemplate.new(Dir.pwd, *args).tap { |pt| yield pt }
     end
   end
 end

data/lib/shanty/discoverers/rubygem.rb

@@ -0,0 +1,17 @@
+require 'shanty/discoverer'
+require 'shanty/projects/rubygem'
+
+module Shanty
+  # Public: Discoverer for Shantyfiles
+  # will create a a project for every Shantyfile it finds in
+  # a directory
+  class RubygemDiscoverer < Discoverer
+    def discover
+      Dir[File.join(env.root, '**', '*.gemspec')].map do |path|
+        create_project_template(File.absolute_path(File.dirname(path))) do |project_template|
+          project_template.type = RubygemProject
+        end
+      end
+    end
+  end
+end

data/lib/shanty/discoverers/shantyfile.rb

@@ -5,10 +5,17 @@ module Shanty
   # Public: Discoverer for Shantyfiles
   # will create a a project for every Shantyfile it finds in
   # a directory
+  #
+  # Note that this does not execute the Shantyfile. That
+  # happens inside the ProjectTemplate as we may have projects
+  # discovered by other discoverers that still need
+  # customisation.
   class ShantyfileDiscoverer < Discoverer
     def discover
-      Dir['**/Shantyfile'].map do |path|
-        create_project(File.absolute_path(File.dirname(path)))
+      Dir[File.join(env.root, '**', 'Shantyfile')].map do |path|
+        create_project_template(File.absolute_path(File.dirname(path))) do |project_template|
+          project_template.priority = -1
+        end
       end
     end
   end

data/lib/shanty/env.rb

@@ -0,0 +1,51 @@
+require 'deep_merge'
+require 'yaml'
+
+module Shanty
+  #
+  class Env
+    CONFIG_FILE = '.shanty.yml'
+    DEFAULT_CONFIG = {}
+
+    def initialize
+      Dir.chdir(root) do
+        (config['require'] || {}).each do |requirement|
+          requirement = "#{requirement}/**/*.rb" unless requirement.include?('.rb')
+          Dir[requirement].each { |f| require(File.join(root, f)) }
+        end
+      end
+    end
+
+    def environment
+      @environment = ENV['SHANTY_ENV'] || 'local'
+    end
+
+    def root
+      @root ||= find_root
+    end
+
+    private
+
+    def config
+      return @config unless @config.nil?
+
+      file_config = YAML.load_file("#{root}/#{CONFIG_FILE}") || {}
+      @config = DEFAULT_CONFIG.deep_merge!(file_config[environment])
+    end
+
+    def find_root
+      if root_dir.nil?
+        fail "Could not find a #{CONFIG_FILE} file in this or any parent directories. \
+        Please run `shanty init` in the directory you want to be the root of your project structure."
+      end
+
+      root_dir
+    end
+
+    def root_dir
+      Pathname.new(Dir.pwd).ascend do |d|
+        return d if d.join(CONFIG_FILE).exist?
+      end
+    end
+  end
+end

data/lib/shanty/graph.rb

@@ -1,4 +1,6 @@
 require 'algorithms'
+require 'forwardable'
+require 'tsort'
 
 module Shanty
   # Public: Represents the link graph of projects in the repository. This class is
@@ -7,20 +9,22 @@ module Shanty
   # projects need to be build by combining a Git diff with the dependency graph
   # to resolve to a list of projects required to be built.
   class Graph
-    attr_reader :projects
+    extend Forwardable
+    include TSort, Enumerable
+
+    def_delegators :@projects, :<<, :length, :add, :remove
+    def_delegators :sorted_projects, :each, :values, :[]
 
     # Public: Initialise a ProjectLinkGraph.
     #
-    # projects - An array of project instances to take and link together into
-    #            a graph structure of dependencies.
-    def initialize(projects)
-      @projects = sort_projects(link_projects(projects))
-
+    # project_templates - An array of project templates to take, instantiate and
+    #                     link together into a graph structure of dependencies.
+    def initialize(project_templates)
       @project_path_trie = Containers::Trie.new
+      @project_templates = project_templates
+      @projects = projects_by_path.values
 
-      @projects.each do |project|
-        @project_path_trie[project.path] = project
-      end
+      link_projects
     end
 
     # Public: All the changed projects in the current repository.
@@ -28,7 +32,7 @@ module Shanty
     # Returns an Array of Project subclasses, one for each project in the
     # repository.
     def changed
-      @projects.select { |project| project.changed? }
+      select(&:changed?)
     end
 
     # Public: Returns a project, if any, with the given name.
@@ -37,7 +41,7 @@ module Shanty
     #
     # Returns an instance of a Project subclass if found, otherwise nil.
     def by_name(name)
-      @projects.find { |project| project.name == name }
+      find { |project| project.name == name }
     end
 
     # Public: Returns all projects of the given types.
@@ -47,7 +51,7 @@ module Shanty
     # Returns an Array of Project subclasses, one for each project in the
     # repository.
     def all_of_type(*types)
-      @projects.select { |project| types.include?(project.class) }
+      select { |project| types.include?(project.class) }
     end
 
     # Public: Returns all the changed projects of the given types.
@@ -85,6 +89,26 @@ module Shanty
 
     private
 
+    def sorted_projects
+      @sorted_projects ||= tsort
+    end
+
+    def tsort_each_node
+      @projects.each { |p| yield p }
+    end
+
+    def tsort_each_child(project)
+      projects_by_path[project.path].parents.each { |p| yield p }
+    end
+
+    def projects_by_path
+      @projects_by_path ||= Hash[@project_templates.map do |project_template|
+        project = project_template.type.new(project_template)
+        @project_path_trie[project.path] = project
+        [project.path, project]
+      end]
+    end
+
     # Private: Given a list of projects, construct the parent/child
     # relationships between them given a list of their parents/children by name
     # as defined on the project instances.
@@ -92,31 +116,18 @@ module Shanty
     # projects - An array of Project subclasses to link together.
     #
     # Returns an Array of linked projects.
-    def link_projects(projects)
-      projects_by_name = projects.each_with_object({}) { |project, acc| acc[project.name] = project }
+    def link_projects
+      projects_by_path.each_value do |project|
+        project.parents_by_path.each do |parent_path|
+          parent_dependency = projects_by_path[parent_path]
+          if parent_dependency.nil?
+            fail("Cannot find project at path #{parent_path}, which was specified as a dependency for #{project}")
+          end
 
-      projects.each do |project|
-        parent_dependencies = project.parents_by_name.map { |parent_name| projects_by_name[parent_name] }.compact
-
-        parent_dependencies.each do |parent_dependency|
           project.add_parent(parent_dependency)
           parent_dependency.add_child(project)
         end
       end
-
-      projects
-    end
-
-    # Private: Given a list of Project subclasses, sort them by their distance
-    # from the root node (that is, the topmost node). This order is important
-    # because it matches the order in which things should be build to avoid
-    # missing dependencies.
-    #
-    # projects - An array of Project subclasses to sort.
-    #
-    # Returns a sorted Array of Project subclasses.
-    def sort_projects(projects)
-      projects.sort { |a, b| a.distance_from_root <=> b.distance_from_root }
     end
   end
 end

data/lib/shanty/mixins/acts_as_link_graph_node.rb

@@ -66,16 +66,6 @@ module Shanty
       def all_parents
         parents + parents.map(&:all_parents).flatten
       end
-
-      # Public: Calculate the maximum number of traverses that need to be made to
-      # reach the root from this node.
-      #
-      # Returns a Fixnum representing the traverses to the root. Note that a return
-      # value of 0 means this is the root (ie. it has no parents).
-      def distance_from_root
-        return 0 if parents.empty?
-        parents.map(&:distance_from_root).max + 1
-      end
     end
   end
 end

data/lib/shanty/mixins/callbacks.rb

@@ -1,5 +1,3 @@
-require 'hooks'
-
 module Shanty
   module Mixins
     # A mixin to implement publish/subscribe style callbacks in the class that
@@ -15,24 +13,38 @@ module Shanty
       # to call extend and include for this mixin. You'll see this idiom everywhere
       # in the Ruby/Rails world, so we use it too.
       def self.included(cls)
-        cls.include(Hooks)
         cls.extend(ClassMethods)
       end
 
       # Common methods inherited by all classes
       module ClassMethods
+        def class_callbacks
+          @class_callbacks ||= Hash.new { |h, k| h[k] = [] }
+        end
+
         def subscribe(*names, sym)
           names.each do |name|
-            define_hook(name, halts_on_falsey: true) unless respond_to?(name)
-            send(name, sym)
+            class_callbacks[name] << sym
           end
         end
       end
 
+      def callbacks
+        @callbacks ||= Hash.new { |h, k| h[k] = [] }
+      end
+
+      def subscribe(*names, sym)
+        names.each do |name|
+          callbacks[name] << sym
+        end
+      end
+
       def publish(name, *args)
-        return true if self.class.callbacks_for_hook(name).nil?
-        results = run_hook(name, *args)
-        !results.halted?
+        class_callback_methods = self.class.class_callbacks[name]
+        callback_methods = callbacks[name]
+
+        (class_callback_methods + callback_methods).each { |method| return false unless send(method, *args) }
+        true
       end
     end
   end