dirt 0.1.1

data/core/tests/behaviours/support/helpers.rb

@@ -0,0 +1,21 @@
+require 'rspec/matchers'
+
+RSpec::Matchers.define :exist do
+  match do |actual_path|
+    File.exist?(actual_path) == true
+  end
+
+  failure_message_for_should do |actual|
+    "expected '#{actual.to_s}' to exist"
+  end
+end
+
+def recent_history(n=1)
+  unless @commands
+    FakeFS.deactivate!
+    @commands = history.to_a
+    FakeFS.activate!
+  end
+
+  @commands.shift(n)
+end

data/core/tests/factories.rb

@@ -0,0 +1,23 @@
+#--
+# Copyright (c) 2014 Tenjin Inc.
+#
+# 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/core/version.rb

@@ -0,0 +1,3 @@
+module Dirt
+  VERSION = '0.1.1'
+end

data/faces/cli/bin/dirt

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'bundler'
+#Bundler.setup(:default)
+require_relative '../optparse/main'
+
+Samling::Cli::Main.new.execute!(ARGV.dup)

data/faces/cli/integrations/generate_context.feature

@@ -0,0 +1,40 @@
+Feature: it should create new Dirt context in the context directory
+
+  Scenario:
+    Given this feature is unimplemented
+
+  # Happy cases:
+  # dirt generate context CLASSNAME
+
+  # Unhappy cases:
+  # dirt generate context
+
+
+#  Scenario Outline: Running with just project flag
+#    Given I am in "<parent_path>"
+#    When I run dirt generate with:
+#      | flag    | value          |
+#      | project | <project_name> |
+#    Then it should say "Time to grow, little <project_name>..."
+#    And it should say "Created project structure in <parent_path>/<project_directory>."
+#    And ls should show the following files in "<parent_path>/<project_directory>":
+#      | path                                   |
+#      | config                                 |
+#      | dirt/contexts                          |
+#      | dirt/contexts/roles                    |
+#      | dirt/models                            |
+#      | dirt/tests/behaviours                  |
+#      | dirt/tests/behaviours/support          |
+#      | dirt/tests/behaviours/step_definitions |
+#      | dirt/tests/isolations                  |
+#      | faces                                  |
+#  Examples:
+#    | parent_path           | project_directory | project_name     |
+#    |                       | my_project        | My Project       |
+#    | a_path/to/the project | my_project        | My Project       |
+#    |                       | my_other_project  | My Other Project |
+#    | some/other/path       | my_other_project  | My Other Project |
+#
+#  Scenario: it should require a project name
+#    When I run dirt generate with no args
+#    Then it should say "Usage: samling [options] arguments"

data/faces/cli/integrations/generate_face.feature

@@ -0,0 +1,53 @@
+Feature: it should create new face with its default contents
+  # === Happy cases ====
+  Scenario Outline: dirt generate face PLATFORM
+    Given this feature is unimplemented
+  Examples:
+    | nope |
+
+  Scenario Outline: dirt generate face PLATFORM/ENGINE
+    Given this feature is unimplemented
+  Examples:
+    | nope |
+
+  # === Unhappy cases ====
+  # dirt generate project --name test --face
+  Scenario: Generate project with name and face but no face arg
+    Given this feature is unimplemented
+
+  # dirt generate face no_platform
+  Scenario: Generate face but platform does not exist
+    Given this feature is unimplemented
+
+  # dirt generate face platform/no_engine
+  Scenario: Generate face but engine does not exist
+    Given this feature is unimplemented
+
+#  Scenario Outline: Running with just project flag
+#    Given I am in "<parent_path>"
+#    When I run dirt generate with:
+#      | flag    | value          |
+#      | project | <project_name> |
+#    Then it should say "Time to grow, little <project_name>..."
+#    And it should say "Created project structure in <parent_path>/<project_directory>."
+#    And ls should show the following files in "<parent_path>/<project_directory>":
+#      | path                                   |
+#      | config                                 |
+#      | dirt/contexts                          |
+#      | dirt/contexts/roles                    |
+#      | dirt/models                            |
+#      | dirt/tests/behaviours                  |
+#      | dirt/tests/behaviours/support          |
+#      | dirt/tests/behaviours/step_definitions |
+#      | dirt/tests/isolations                  |
+#      | faces                                  |
+#  Examples:
+#    | parent_path           | project_directory | project_name     |
+#    |                       | my_project        | My Project       |
+#    | a_path/to/the project | my_project        | My Project       |
+#    |                       | my_other_project  | My Other Project |
+#    | some/other/path       | my_other_project  | My Other Project |
+#
+#  Scenario: it should require a project name
+#    When I run dirt generate with no args
+#    Then it should say "Usage: samling [options] arguments"

data/faces/cli/integrations/generate_model.feature

@@ -0,0 +1,11 @@
+Feature: it should create new Dirt model in the models directory
+
+  Scenario:
+    Given this feature is unimplemented
+
+  # Happy cases:
+  # dirt generate model CLASSNAME
+
+  # Unhappy cases:
+  # dirt generate model
+

data/faces/cli/integrations/generate_project.feature

@@ -0,0 +1,143 @@
+Feature: it should create new project with its default contents and an accompanying git repo
+
+  # === Happy cases ====
+  # dirt generate project --name NAME --bare-path PATH
+  Scenario Outline: generate project with just name, assume location is CWD
+    Given I am in "<parent path>"
+    When I generate a project with:
+      | flag      | value        |
+      | name      | <given name> |
+      | bare-path | <bare path>  |
+    Then it should say "Time to grow, little <displayed name>..."
+    And it should have called "git init --bare <bare path>/<project directory>.git"
+    And ls should show the following files in "<parent path>/<project directory>":
+      | path                                   |
+      | core/contexts                          |
+      | core/contexts/roles                    |
+      | core/models                            |
+      | core/tests/behaviours                  |
+      | core/tests/behaviours/support          |
+      | core/tests/behaviours/step_definitions |
+      | core/tests/isolations                  |
+      | faces                                  |
+      | persist                                 |
+    And it should say "Created project structure in <parent path>/<project directory>."
+    And it should say "Comitting and pushing..."
+    And it should have called "git --git-dir "<parent path>/<project directory>/.git" --work-tree "<parent path>/<project directory>" push origin master"
+  Examples:
+    | given name       | displayed name   | parent path            | project directory | bare path       |
+    | my project       | My Project       | /a_path/to/the project | my_project        | some/git        |
+    | my other project | My Other Project | /some/other/path       | my_other_project  | different/bares |
+
+  # dirt generate project --name NAME --location PATH --bare-path PATH
+  Scenario Outline: generate project with location
+    Given I am in "/"
+    When I generate a project with:
+      | flag      | value         |
+      | name      | my project    |
+      | bare-path | some/git      |
+      | location  | <parent path> |
+    And it should have called "git init --bare some/git/my_project.git"
+    And it should say "Created project structure in <parent path>/my_project." somewhere
+    And it should have called "git --git-dir "<parent path>/my_project/.git" --work-tree "<parent path>/my_project" push origin master"
+  Examples:
+    | parent path            |
+    | /a_path/to/the project |
+    | /some/other/path       |
+
+    # dirt generate project --name NAME --bare-path PATH --host HOSTNAME
+  Scenario Outline: generate project with host name, assume user
+    Given I am in "<project path>"
+    And that I am logged in as "<user>" on <platform>
+    When I generate a project with:
+      | flag      | value       |
+      | name      | my project  |
+      | bare-path | <bare path> |
+      | host      | <host>      |
+    And it should have called "ssh <user>\@<host> "git init --bare <bare path>/my_project.git""
+    And it should say "Created project structure in <project path>/my_project." somewhere
+    And it should have called "git --git-dir "<project path>/my_project/.git" --work-tree "<project path>/my_project" push origin master"
+  Examples:
+    | platform | host     | user  | bare path       | project path           |
+    | linux    | machine1 | userA | some/git        | /a_path/to/the project |
+    | windows  | machine1 | userA | some/git        | /a_path/to/the project |
+    | linux    | machine2 | userB | different/bares | /some/other/path       |
+    | windows  | machine2 | userB | different/bares | /some/other/path       |
+
+  # dirt generate project --name NAME --bare-path PATH --host HOSTNAME --user USER
+  Scenario Outline: generate project with host name and user
+    Given I am in "<project path>"
+    When I generate a project with:
+      | flag      | value       |
+      | name      | my project  |
+      | bare-path | <bare path> |
+      | host      | <host>      |
+      | user      | <user>      |
+    And it should have called "ssh <user>\@<host> "git init --bare <bare path>/my_project.git""
+    And it should say "Created project structure in <project path>/my_project." somewhere
+    And it should have called "git --git-dir "<project path>/my_project/.git" --work-tree "<project path>/my_project" push origin master"
+  Examples:
+    | host     | user  | bare path       | project path           |
+    | machine1 | userA | some/git        | /a_path/to/the project |
+    | machine2 | userB | different/bares | /some/other/path       |
+
+  #  dirt generate project --name NAME --face PLATFORM/ENGINE
+  Scenario Outline: Generate project with face
+    Given this feature is unimplemented
+  Examples:
+    | nope |
+    |      |
+
+  # dirt generate project --name NAME --location PATH --face PLATFORM/ENGINE
+  Scenario Outline: Generate project with location and face
+    Given this feature is unimplemented
+  Examples:
+    | nope |
+    |      |
+
+  # === Unhappy cases ====
+  # dirt generate project
+  Scenario: Generate project without name
+    When I generate a project with:
+      | flag      | value    |
+      | bare-path | anything |
+    Then it should say the usage
+    And it should exit with an error
+
+  # dirt generate project
+  Scenario: Generate project without bare path
+    When I generate a project with:
+      | flag | value    |
+      | name | anything |
+    Then it should say the usage
+    And it should exit with an error
+
+
+#  Scenario Outline: Running with just project flag
+#    Given I am in "<parent_path>"
+#    When I run dirt generate with:
+#      | flag    | value          |
+#      | project | <project_name> |
+#    Then it should say "Time to grow, little <project_name>..."
+#    And it should say "Created project structure in <parent_path>/<project_directory>."
+#    And ls should show the following files in "<parent_path>/<project_directory>":
+#      | path                                   |
+#      | config                                 |
+#      | core/contexts                          |
+#      | core/contexts/roles                    |
+#      | core/models                            |
+#      | core/tests/behaviours                  |
+#      | core/tests/behaviours/support          |
+#      | core/tests/behaviours/step_definitions |
+#      | core/tests/isolations                  |
+#      | faces                                  |
+#  Examples:
+#    | parent_path           | project_directory | project_name     |
+#    |                       | my_project        | My Project       |
+#    | a_path/to/the project | my_project        | My Project       |
+#    |                       | my_other_project  | My Other Project |
+#    | some/other/path       | my_other_project  | My Other Project |
+#
+#  Scenario: it should require a project name
+#    When I run dirt generate with no args
+#    Then it should say "Usage: samling [options] arguments"

data/faces/cli/integrations/generate_role.feature

@@ -0,0 +1,12 @@
+Feature: it should create Dirt role in roles directory
+
+  Scenario:
+    Given this feature is unimplemented
+
+  # Happy cases:
+  # dirt generate role CLASSNAME
+
+  # Unhappy cases:
+  # dirt generate role
+
+

data/faces/cli/integrations/step_definitions/given.rb

@@ -0,0 +1,16 @@
+Given(/^this feature is unimplemented$/) do
+  pending 'This feature is yet to be fleshed out.'
+end
+
+Given(/^I am in "(.*?)"$/) do |path|
+  FileUtils.mkdir_p(path)
+  @run_dir = path
+end
+
+Given(/^that I am logged in as "(.*?)" on (windows|linux)$/) do |username, platform|
+  if platform == 'linux'
+    ENV['USER'] = username
+  else
+    ENV['USERNAME'] = username
+  end
+end

data/faces/cli/integrations/step_definitions/then.rb

@@ -0,0 +1,48 @@
+Then(/^it should say "(.*?)"$/) do |msg|
+  @output.readline.strip.should == msg
+end
+
+Then(/^it should say "(.*?)" somewhere$/) do |msg|
+  pos = @output.pos
+
+  @output.rewind
+  @output.read.split("\n").should include(msg)
+
+  @output.seek(pos)
+end
+
+Then(/^it should say the usage$/) do
+  pos = @output.pos
+
+  @output.rewind
+  (@output.read || '').should include 'Usage:'
+
+  @output.seek(pos)
+end
+
+Then(/^ls should show the following files in "(.*?)":$/) do |location, table|
+  Dir.chdir(location) do
+
+    # ideally use `tree -ifd` instead
+
+    paths = Dir[location + '/**/*']
+
+    table.hashes.collect do |h|
+      paths.should include h[:path]
+    end
+  end
+end
+
+Then(/^there should( not)? be a( central)? git repository in "(.*?)"$/) do |exists, central, location|
+  pending 'use ls to check if there is a .git repo in that file'
+end
+
+Then(/^it should have called "(.*?)"$/) do |command|
+  FakeFS.deactivate!
+  history.should include command.shellsplit
+  FakeFS.activate!
+end
+
+Then(/^it should exit with an error$/) do
+  @exited.should be_true
+end

data/faces/cli/integrations/step_definitions/when.rb

@@ -0,0 +1,28 @@
+When(/^I generate a project with:$/) do |table|
+  Dir.chdir(@run_dir || Dir.pwd) do
+    options = table.hashes.collect do |h|
+      ["--#{h[:flag]}", "#{h[:value]}"]
+    end.flatten
+
+    input = StringIO.new
+    @output = StringIO.new
+    err = StringIO.new
+    kernel = double('kernel')
+
+    kernel.stub(:exit) do
+      raise KernelExited
+    end
+
+    begin
+      Samling::Cli::Main.new(input, @output, err, kernel).execute!(['generate'] + options)
+
+      @output.rewind
+    rescue KernelExited
+      @exited = true
+    end
+  end
+end
+
+When(/^I run dirt generate with no args$/) do
+  expect { step('I run dirt generate with:', table([%w{flag value}])) }.to raise_error(SystemExit)
+end

data/faces/cli/integrations/support/env.rb

@@ -0,0 +1,21 @@
+require './faces/cli/optparse/main.rb'
+
+require './core/tests/behaviours/support/env'
+
+require 'cucumber/rspec/doubles'
+
+Before do
+  @env_user = ENV['USER']
+  @env_username = ENV['USERNAME']
+
+  @exited = false
+end
+
+After do
+  ENV['USER']= @env_user
+  ENV['USERNAME'] = @env_username
+end
+
+class KernelExited < Exception
+
+end

data/faces/cli/optparse/main.rb

@@ -0,0 +1,143 @@
+#--
+# Copyright (c) 2014 Tenjin Inc.
+#
+# 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.
+#++
+
+src_dir = File.expand_path('../../../../core', __FILE__)
+$LOAD_PATH.unshift(src_dir) unless $LOAD_PATH.include?(src_dir)
+
+require 'dirt'
+
+require 'optparse'
+require 'yaml'
+
+module Samling
+  module Cli
+    # Main command line interface (CLI) controller. Handles standard CLI input.
+    class Main
+      # Defines each of the standard OS interfaces to default values, unless
+      # otherwise specified.
+      def initialize(stdin=STDIN, stdout=STDOUT, stderr=STDERR, kernel=Kernel)
+        $stdin, $stdout, $stderr = stdin, stdout, stderr
+
+        @kernel = kernel
+      end
+
+      # The primary invocation method for the application.
+      # It sets up the components of the application as
+      # required by the input arguments, then runs the Contexts.
+      def execute!(argv)
+        options = parse_args(argv)
+
+        select_and_run_context(options)
+      end
+
+      # Parses the argument array as received from the CLI.
+      def parse_args(args)
+        options = {}
+        args ||= []
+
+        parser = OptionParser.new do |opts|
+          opts.banner = 'Usage: dirt generate [options]'
+
+          opts.separator ''
+          opts.separator 'Specific options:'
+
+          # ===================================
+          # Add option recognisers here
+          # ===================================
+
+          opts.on('-n', '--name NAME',
+                  'The human-readable name of the new project. Put it in quotes if you want spaces.') do |name|
+            options[:project_name] = name.titlecase
+          end
+
+          opts.on('-l', '--location PATH',
+                  'The parent directory of the new project on the local machine.') do |path|
+            options[:project_parent] = Pathname.new(path)
+          end
+
+          opts.on('-b', '--bare-path PATH',
+                  'The parent directory of the new git bare on the host machine. See --host.') do |path|
+            options[:bare_path] = Pathname.new(path)
+          end
+
+          opts.on('-h', '--host ADDRESS',
+                  'The IP address or name of the machine where the bare repository will be kept. Defaults to localhost.') do |host|
+            options[:vcs_host] = host
+          end
+
+          opts.on('-u', '--user NAME',
+                  'The username to be used to log into the host device. Defaults to the name of the user running this script. See --host.') do |name|
+            options[:vcs_user] = name
+          end
+
+          # opts.on('-n', '--no-git',
+          #         'Skip the git steps.') do |use_git|
+          #   options[:use_vcs] = use_git
+          # end
+
+          # opts.on('--version',
+          #         'Print program version and exit.') do |version|
+          #   options[:version] = version
+          # end
+        end
+
+        parser.parse!(args)
+
+        # config_options = YAML.load_file(options[:config_path] || './persist/persist.yml')
+        #
+        # options = config_options.merge(options)
+
+        options[:project_parent] ||= Pathname.new(Dir.pwd)
+        options[:vcs_user] ||= ENV['USERNAME'] || ENV['USER']
+
+        # Capture remaining, non-flag normal arguments
+        # options[:arguments] = args
+
+        assert_required!(options, parser)
+
+        return options
+      end
+
+      def assert_required!(options, parser)
+        unless options[:project_name] && options[:bare_path]
+          puts parser
+          @kernel.exit
+        end
+      end
+
+      def select_and_run_context(options)
+        project_directory = options[:project_name].gsub(' ', '').underscore
+        project_directory = options[:project_parent].expand_path + project_directory
+
+        puts "Time to grow, little #{options[:project_name]}..."
+
+        # puts 'Skipping git steps.'
+        CreateGitRepository.run(project_directory, options[:bare_path], options[:vcs_host], options[:vcs_user])
+
+        puts CreateDefaultStructure.run(project_directory)
+
+        puts CommitGitRepository.run(project_directory)
+      end
+    end
+  end
+end