dirt 0.1.1

data/core/contexts/create_git_repository.rb

@@ -0,0 +1,45 @@
+#--
+# 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.
+#++
+
+module Samling
+  class CreateGitRepository < Dirt::Context
+    def initialize(project_path, bare_parent_path, host, user)
+      @project_path = Pathname.new(project_path)
+      @bare_path = Pathname.new(bare_parent_path) + (@project_path.basename.to_s + '.git')
+      @host = host
+      @user = user
+    end
+
+    def call
+      if @host.blank?
+        system(%Q{git init --bare #{@bare_path}})
+        system(%Q{git clone "#{@bare_path}" "#{@project_path}"})
+      else
+        system(%Q{ssh #{@user}@#{@host} "git init --bare #{@bare_path}"})
+        system(%Q{git clone #{@user}@#{@host}:#{@bare_path} "#{@project_path}"})
+      end
+    end
+  end
+end
+
+

data/core/contexts/roles/generating.rb

@@ -0,0 +1,26 @@
+module Samling
+  class Generating < Dirt::Role
+    def generate_templates(generated_project_root)
+      templates_dir = Dirt::PROJECT_ROOT + 'templates/'
+      project_name = generated_project_root.basename.to_s
+
+      @decorated.each do |f, t|
+        file = generated_project_root + f.gsub('project_name', project_name)
+
+        FileUtils.mkdir_p(file.dirname)
+
+        if t
+          template_file = templates_dir + t
+
+          file.open('w') do |file|
+            content = File.read(template_file.to_s).gsub('<project_name>', project_name)
+
+            file.write(content)
+          end
+        else
+          FileUtils.touch(file.to_s)
+        end
+      end
+    end
+  end
+end

data/core/dirt.rb

@@ -0,0 +1,14 @@
+require 'pathname'
+require 'dirt/core'
+require 'active_support'
+
+app_dir = Pathname.new(__FILE__).dirname
+
+# require ALL the files!
+Dir["#{app_dir}/**/*.rb"].reject { |f| f.include?('/faces/') || f.include?('/tests/') }.each do |file|
+  require file
+end
+
+module Dirt
+  PROJECT_ROOT = Pathname.new(File.dirname(__FILE__) + '/..').realpath
+end

data/core/tests/behaviours/commit_files.feature

@@ -0,0 +1,36 @@
+Feature: it should commit all files and directories to VCS
+
+  Scenario Outline: committing the default structure
+    Given the default structure exists in "<project_directory>"
+    And the following files exist:
+      | path                                      |
+      | <project_directory>/.git/some_git_file    |
+      | <project_directory>/.git/.hidden_git_file |
+    When it commits all files and directories in "<project_directory>"
+    Then there should be .gitkeep files in exactly the following directories of "<project_directory>"
+      | path                  |
+      | core/contexts/roles   |
+      | core/models           |
+      | core/tests/isolations |
+      | faces                 |
+      | persist               |
+    And it should run git add on exactly the following files in "<project_directory>":
+      | path                                            |
+      | Gemfile                                         |
+      | .gitignore                                      |
+      | core/<project_name>.rb                          |
+      | core/contexts/roles/.gitkeep                    |
+      | core/models/.gitkeep                            |
+      | core/tests/behaviours/support/env.rb            |
+      | core/tests/behaviours/step_definitions/given.rb |
+      | core/tests/behaviours/step_definitions/when.rb  |
+      | core/tests/behaviours/step_definitions/then.rb  |
+      | core/tests/isolations/.gitkeep                  |
+      | faces/.gitkeep                                  |
+      | persist/.gitkeep                                |
+    And it should run "git --git-dir "<project_directory>/.git" --work-tree "<project_directory>" commit -am "Project init with Dirt.""
+    And it should run "git --git-dir "<project_directory>/.git" --work-tree "<project_directory>" push origin master"
+  Examples:
+    | project_directory                 | project_name     |
+    | /a_path/to/the project/my_project | my_project       |
+    | /some/other/path/my_other_project | my_other_project |

data/core/tests/behaviours/create_basic_face.feature

@@ -0,0 +1,49 @@
+Feature: create default face
+
+  Scenario Outline: the project root directory does not exist
+    When I create a new basic face "<face_name>" at "<project_root>"
+    Then there should be exactly the following directories in "<project_root>/faces/<face_name>":
+      | path                          |
+      | integrations                  |
+      | integrations/support          |
+      | integrations/step_definitions |
+  Examples:
+    | project_root           | face_name     |
+    |                        | my_face       |
+    | /a_path/to/the project | my_face       |
+    |                        | my_other_face |
+    | /some/other/path       | my_other_face |
+
+  Scenario Outline: parent directories exist
+    Given the following directories exist:
+      | path                                                            |
+      | <project_path>/faces/<face_name>/integrations/support/          |
+      | <project_path>/faces/<face_name>/integrations/step_definitions/ |
+    When I create a new basic face "<face_name>" at "<project_path>"
+    Then there should be files for "<project_name>" from templates:
+      | path                                                                     | template        |
+      | /<project_path>/faces/<face_name>/integrations/support/env.rb            | template.env.rb |
+      | /<project_path>/faces/<face_name>/integrations/step_definitions/given.rb |                 |
+      | /<project_path>/faces/<face_name>/integrations/step_definitions/when.rb  |                 |
+      | /<project_path>/faces/<face_name>/integrations/step_definitions/then.rb  |                 |
+  Examples:
+    | project_name    | project_path              | face_name |
+    | my_project      | my_project                | web       |
+    | another_project | somewhere/another_project | web       |
+    | my_project      | my_project                | cli       |
+    | another_project | somewhere/another_project | cli       |
+
+  Scenario Outline: parent directories do not exist
+    When I create a new basic face "<face_name>" at "<project_path>"
+    Then there should be files for "<project_name>" from templates:
+      | path                                                                    | template        |
+      | <project_path>/faces/<face_name>/integrations/support/env.rb            | template.env.rb |
+      | <project_path>/faces/<face_name>/integrations/step_definitions/given.rb |                 |
+      | <project_path>/faces/<face_name>/integrations/step_definitions/when.rb  |                 |
+      | <project_path>/faces/<face_name>/integrations/step_definitions/then.rb  |                 |
+  Examples:
+    | project_name    | project_path              | face_name |
+    | my_project      | my_project                | web       |
+    | another_project | somewhere/another_project | web       |
+    | my_project      | my_project                | cli       |
+    | another_project | somewhere/another_project | cli       |

data/core/tests/behaviours/create_default_structure.feature

@@ -0,0 +1,55 @@
+Feature: it should create the expected directory tree
+
+  Scenario Outline: the project root directory does not exist
+    When I create a new project in "<full_project_path>"
+    Then there should be exactly the following directories in "/<full_project_path>":
+      | path                                   |
+      | core                                   |
+      | core/contexts                          |
+      | core/contexts/roles                    |
+      | core/models                            |
+      | core/tests                             |
+      | core/tests/behaviours                  |
+      | core/tests/behaviours/support          |
+      | core/tests/behaviours/step_definitions |
+      | core/tests/isolations                  |
+      | faces                                  |
+      | persist                                |
+  Examples:
+    | full_project_path                |
+    | my_project                       |
+    | a_path/to/the project/my_project |
+    | my_other_project                 |
+    | some/other/path/my_other_project |
+
+  Scenario Outline: parent directories exist
+    Given the following directories exist:
+      | path                                          |
+      | <project_path>/core/tests/behaviours/support/ |
+    When I create a new project in "<project_path>"
+    Then there should be files for "<project_name>" from templates:
+      | path                                                           | template                 |
+      | <project_path>/core/<project_name>.rb                          | template.project_name.rb |
+      | <project_path>/Gemfile                                         | template.Gemfile         |
+      | <project_path>/.gitignore                                      | template.gitignore       |
+      | <project_path>/core/tests/behaviours/support/env.rb            | template.env.rb          |
+      | <project_path>/core/tests/behaviours/step_definitions/given.rb |                          |
+      | <project_path>/core/tests/behaviours/step_definitions/when.rb  |                          |
+      | <project_path>/core/tests/behaviours/step_definitions/then.rb  |                          |
+  Examples:
+    | project_path              | project_name    |
+    | my_project                | my_project      |
+    | somewhere/another_project | another_project |
+
+  Scenario Outline: parent directories do not exist
+    When I create a new project in "<project_path>"
+    Then there should be files for "<project_name>" from templates:
+      | path                                                | template                 |
+      | <project_path>/core/<project_name>.rb               | template.project_name.rb |
+      | <project_path>/Gemfile                              | template.Gemfile         |
+      | <project_path>/.gitignore                           | template.gitignore       |
+      | <project_path>/core/tests/behaviours/support/env.rb | template.env.rb          |
+  Examples:
+    | project_name    | project_path              |
+    | my_project      | my_project                |
+    | another_project | somewhere/another_project |

data/core/tests/behaviours/create_vcs_repository.feature

@@ -0,0 +1,26 @@
+Feature: create VCS repository
+
+  # It may be that one day we want to separate bare creation to a switchable step,
+  # but we don't need it yet - remiller
+
+  Scenario Outline: local host
+    When it creates a VCS bare under bare_path: "<given_bare_path>", and project_path: "<working_project_path>"
+    Then it should run exactly:
+      | command                                              |
+      | git init --bare <created_bare_path>                  |
+      | git clone <created_bare_path> <working_project_path> |
+  Examples:
+    | working_project_path | given_bare_path | created_bare_path           |
+    | the/project/path     | some            | some/path.git               |
+    | another/project      | different/bares | different/bares/project.git |
+
+  Scenario Outline: remote host
+    When it creates a bare VCS under host: "<host>", user: "<user>", bare_path: "<given_bares_path>", and project_path: "<working_project_path>"
+    Then it should run exactly:
+      | command                                                            |
+      | ssh <user>@<host> "git init --bare <created_bare_path>"            |
+      | git clone <user>@<host>:<created_bare_path> <working_project_path> |
+  Examples:
+    | host     | user  | working_project_path     | given_bares_path | created_bare_path                    |
+    | machine1 | userA | the/project/my_project   | some/git/        | some/git/my_project.git              |
+    | machine2 | userB | another/my_other_project | different/bares  | different/bares/my_other_project.git |

data/core/tests/behaviours/step_definitions/given.rb

@@ -0,0 +1,18 @@
+Given(/^a step that is unimplemented$/) do
+  pending 'Finish defining this test!'
+end
+
+Given(/^the following (files|directories) exist:$/) do |type, table|
+  table.hashes.each do |h|
+    if type == 'directories'
+      FileUtils.mkdir_p(h[:path])
+    else
+      FileUtils.mkdir_p(File.dirname(h[:path]))
+      FileUtils.touch(h[:path])
+    end
+  end
+end
+
+Given(/^the default structure exists in "(.*?)"$/) do |project_dir|
+  Samling::CreateDefaultStructure.run(project_dir)
+end

data/core/tests/behaviours/step_definitions/then.rb

@@ -0,0 +1,55 @@
+Then(/^it should run "(.*?)"$/) do |command|
+  recent_history.should include command.shellsplit
+end
+
+Then(/^it should run exactly:$/) do |table|
+  commands = table.hashes.collect do |h|
+    h[:command].shellsplit
+  end
+
+  recent_history(commands.size).should == commands
+end
+
+Then(/^it should run git add on exactly the following files in "(.*?)":$/) do |base_path, table|
+  expected_commands = table.hashes.collect do |h|
+    path = Pathname.new(base_path) + h[:path]
+
+    %Q{git --git-dir "#{base_path}/.git" --work-tree "#{base_path}" add -v "#{path}"}.shellsplit
+  end
+
+  recent_history(expected_commands.size).should =~ expected_commands
+end
+
+Then(/^there should be exactly the following (files|directories) in "(.*?)":$/) do |type, location, table|
+  created_files = Dir.glob(location + '/**/*').select { |f| type == 'files' ? File.file?(f) : File.directory?(f) }
+  expected_files = table.hashes.collect { |h| (Pathname.new(location) + h[:path]).to_s }
+
+  created_files.should =~ expected_files
+end
+
+Then(/^there should be \.gitkeep files in exactly the following directories of "(.*?)"$/) do |project_directory, table|
+  table.hashes.each do |h|
+    expected_file = (Pathname.new(project_directory) + h[:path]) + '.gitkeep'
+    expected_file.should exist
+    expected_file.file?.should be_true
+  end
+end
+
+Then(/^there should be files for "(.*?)" from templates:$/) do |project_name, table|
+  created_files = table.hashes.collect do |h|
+    h[:path].should exist
+    File.read(h[:path])
+  end
+
+  FakeFS.deactivate!
+  templates = table.hashes.collect do |h|
+    if h[:template].blank?
+      ''
+    else
+      File.read("./templates/#{h[:template]}").gsub('<project_name>', project_name)
+    end
+  end
+  FakeFS.activate!
+
+  created_files.should =~ templates
+end

data/core/tests/behaviours/step_definitions/when.rb

@@ -0,0 +1,21 @@
+When(/^I create a new project in "(.*?)"$/) do |project_path|
+  Samling::CreateDefaultStructure.run(project_path)
+end
+
+When(/^it creates a VCS bare under bare_path: "(.*?)", and project_path: "(.*?)"$/) do |bare_path, project_path|
+  step "it creates a bare VCS under host: \"\", user: \"\", password: \"\", bare_path: \"#{bare_path}\", and project_path: \"#{project_path}\""
+end
+
+When(/^it creates a bare VCS under host: "(.*?)", user: "(.*?)", bare_path: "(.*?)", and project_path: "(.*?)"$/) do |host, user, bare_path, project_path|
+  Samling::CreateGitRepository.run(project_path, bare_path, host, user)
+end
+
+When(/^it commits all files and directories in "(.*?)"$/) do |path|
+  Samling::CommitGitRepository.run(path)
+end
+
+# faces
+
+When(/^I create a new basic face "(.*?)" at "(.*?)"$/) do |face_name, root_path|
+  Samling::CreateBasicFace.run(root_path, face_name)
+end

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

@@ -0,0 +1,100 @@
+require './core/dirt'
+require 'rspec/matchers'
+require 'fakefs/safe'
+require 'aruba-doubles'
+
+Before do
+  ArubaDoubles::Double.setup
+
+  # git init
+  double_cmd(%q{git init --bare /some/git/my_project.git})
+  double_cmd(%q{git init --bare /different/bares/my_other_project.git})
+
+  double_cmd(%q{ssh userA@machine1 "git init --bare /some/git/my_project.git"})
+  double_cmd(%q{ssh userB@machine1 "git init --bare /some/git/my_project.git"})
+  double_cmd(%q{ssh userA@machine2 "git init --bare /different/bares/my_project.git"})
+  double_cmd(%q{ssh userB@machine2 "git init --bare /different/bares/my_project.git"})
+  double_cmd(%q{ssh userB@machine2 "git init --bare /different/bares/my_other_project.git"})
+
+  # git clone
+  double_cmd(%q{git clone "/some/git/my_project.git" "/a_path/to/the project/my_project"})
+  double_cmd(%q{git clone "/some/git/my_project.git" "/some/other/path/my_project"})
+  double_cmd(%q{git clone "/different/bares/my_other_project.git" "/some/other/path/my_other_project"})
+
+  double_cmd(%q{git clone userA@machine1:/some/git/my_project.git "/a_path/to/the project/my_project"})
+  double_cmd(%q{git clone userA@machine1:/different/bares/my_other_project.git "/some/other/path/my_other_project"})
+  double_cmd(%q{git clone userB@machine1:/some/git/my_project.git "/a_path/to/the project/my_project"})
+  double_cmd(%q{git clone userB@machine1:/different/bares/my_other_project.git "/some/other/path/my_other_project"})
+
+  double_cmd(%q{git clone userA@machine2:/some/git/my_project.git "/a_path/to/the project/my_project"})
+  double_cmd(%q{git clone userA@machine2:/different/bares/my_other_project.git "/some/other/path/my_other_project"})
+  double_cmd(%q{git clone userB@machine2:/some/git/my_project.git "/a_path/to/the project/my_project"})
+  double_cmd(%q{git clone userB@machine2:/different/bares/my_other_project.git "/some/other/path/my_other_project"})
+  double_cmd(%q{git clone userB@machine2:/different/bares/my_project.git "/some/other/path/my_project"})
+
+  # git add
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/Gemfile"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/.gitignore"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/core/tests/behaviours/support/env.rb"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/persist/.gitkeep"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/core/contexts/.gitkeep"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/core/contexts/roles/.gitkeep"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/core/models/.gitkeep"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/core/tests/behaviours/.gitkeep"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/core/tests/behaviours/support/.gitkeep"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/core/tests/behaviours/step_definitions/.gitkeep"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/core/tests/isolations/.gitkeep"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" add -v "/a_path/to/the project/my_project/faces/.gitkeep"})
+
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/Gemfile"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/.gitignore"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/core/tests/behaviours/support/env.rb"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/persist/.gitkeep"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/core/contexts/.gitkeep"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/core/contexts/roles/.gitkeep"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/core/models/.gitkeep"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/core/tests/behaviours/.gitkeep"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/core/tests/behaviours/support/.gitkeep"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/core/tests/behaviours/step_definitions/.gitkeep"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/core/tests/isolations/.gitkeep"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" add -v "/some/other/path/my_other_project/faces/.gitkeep"})
+
+  # git commit/push
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" commit -am "Dirt project init"})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" commit -am "Dirt project init"})
+  double_cmd(%q{git --git-dir "/a_path/to/the project/my_project/.git" --work-tree "/a_path/to/the project/my_project" push origin master})
+  double_cmd(%q{git --git-dir "/some/other/path/my_other_project/.git" --work-tree "/some/other/path/my_other_project" push origin master})
+
+  FakeFS::FileSystem.clear
+
+  # clone all persist files into the fake file system
+  Dir['./templates/**/*'].each do |file|
+    FakeFS.deactivate!
+
+    fake_loc = Dirt::PROJECT_ROOT + file
+
+    if File.directory? file
+      FakeFS.activate!
+      FileUtils.mkdir_p(fake_loc)
+    else
+      content = File.read(file)
+      FakeFS.activate!
+      FileUtils.mkdir_p(File.dirname(fake_loc))
+      FileUtils.touch(fake_loc)
+      File.open(fake_loc, 'w+') { |f| f.write(content) }
+    end
+  end
+  FakeFS.activate!
+end
+
+World(ArubaDoubles)
+
+After do
+  FakeFS::FileSystem.clear
+  FakeFS.deactivate!
+
+  ArubaDoubles::Double.teardown
+  history.clear
+end
+
+