dirt 0.1.1

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gem 'dirt-core', '~> 2.2.1', git: 'git://github.com/TenjinInc/dirt-core.git'
+gem 'activesupport'
+
+group :development do
+  gem 'simplecov'
+end
+
+group :test do
+  gem 'rspec', '~> 2.14.1'
+  gem 'cucumber'
+  gem 'capybara'
+  gem 'launchy'
+
+  gem 'fakefs'
+
+  gem 'aruba-doubles'
+
+  gem 'factory_girl', '~> 4.0'
+  gem 'parallel_tests'
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GIT
+  remote: git://github.com/TenjinInc/dirt-core.git
+  revision: 3fe12bced8addd1d2b09a9bd35aef4b469f5e99e
+  specs:
+    dirt-core (2.2.2)
+      activesupport (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    aruba-doubles (1.2.1)
+      cucumber (>= 1.0.2)
+      rspec (>= 2.6.0)
+    builder (3.2.2)
+    capybara (2.4.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    cucumber (1.3.16)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    fakefs (0.5.2)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    launchy (2.4.2)
+      addressable (~> 2.3)
+    mime-types (2.3)
+    mini_portile (0.6.0)
+    minitest (5.4.0)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    parallel (1.2.4)
+    parallel_tests (1.0.5)
+      parallel
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  aruba-doubles
+  capybara
+  cucumber
+  dirt-core (~> 2.2.1)!
+  factory_girl (~> 4.0)
+  fakefs
+  launchy
+  parallel_tests
+  rspec (~> 2.14.1)
+  simplecov

data/MIT-LICENSE

@@ -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/README.md

@@ -0,0 +1,150 @@
+#Dirt
+Make best practices easy. Come play in the Dirt.
+
+##Why Dirt
+Good design is when the easiest usage and the correct usage are one in the same. 
+
+Best practices, however, are often an extra effort; many require configuration every time you start a new project.
+Newbies are too busy learning to put in that effort and that quickly develops into bad habits. 
+Masters find best practices useful, but routine and boring. So we asked ourselves:
+ 
+> What if there was a tool to make best practices simple or even automatic? 
+
+Dirt is the answer to this question.
+
+It exists because we wanted a toolset to automatically set us up for:
+ - Behaviour Driven Development (BDD)
+ - User Story Orientation
+ - A simple, standard project directory structure
+ - Clear separation of concerns - thin views, thin persistence, thick core. 
+ - Use of modern version control systems 
+ - Code analysis & metrics.  
+ 
+**That's the goal of Dirt: make best practices dead easy.** 
+
+##Features
+This is what Dirt gets you right now:
+
+ - **Helpful defaults** Logical directory tree and some useful default meta files
+ 
+ - **Versioning** Start with a git repository initialized, a populated .gitignore, and all default files already committed. 
+ 
+ - **Ready BDD** Working [Cucumber](https://github.com/cucumber/cucumber) test environments and a default Gemfile to support them.
+
+ - **Undead resistance +3** Great for those pesky lich infestations.
+ 
+###Roadmap
+This is where we're headed. If you want to help make it a reality, get in touch!
+
+ - **Face Generation** Web, CLI, and simple mobile. All including integration tests to justify their existence.  
+ - **VCS independence** Written around Git right now, other VCSes should be supported, especially distributed ones. 
+ - **Project Diffing** Wouldn't it be nice to know what in your project is different form the standards, or the templates?
+ - **Architectural linting** Core files should only depend on core files. 
+ - **Licence Injection** Applying the licence to all source files should be easy, and optional.   
+ - **Simple installation** The language and Dirt should just work out of the box. 
+ - **Multilingual Support** These concepts aren't Ruby specific. They can easily apply to any modern language. Where [Cucumber](https://github.com/cucumber/cucumber) and [Gherkin](https://github.com/cucumber/cucumber/wiki/Gherkin) go, Dirt may follow. 
+ - ... Plus some other experimental ideas that BDD enable
+
+## Prerequisites
+Dirt requires [linux or unix](http://www.ubuntu.com/), [git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git), and [ruby](https://www.ruby-lang.org/en/documentation/installation/).  
+
+##Usage
+
+###Project Generation
+
+Generating a project will give you a project directory that looks like:
+
+```
+core/
+├─── contexts/
+│    └─────── roles/
+├── models/
+├── tests/
+│   ├──── behaviours/
+│   │     ├───────── step_definitions/
+│   │     │          ├── given.rb
+│   │     │          ├── then.rb
+│   │     │          └── when.rb
+│   │     └───────── support/
+│   │                └────── env.rb
+│   └───── isolations/
+└── example_project.rb
+faces/
+persist/
+Gemfile
+.gitignore
+```
+
+We'll take a look at a couple of scenarios first: remote host and local host. 
+
+*First, a note about git and dirt*
+Usually, git stores history information in a .git file within your project directory. You can make a *bare* that is a 
+folder with just the history information, and no actual project files. Then, you can point multiple regular git 
+repository's to the bare, and it can act as a shared history.   
+
+Dirt has two intended modes: having a git bare on a remote machine, or on your local machine. 
+
+####Remote Bare Host
+Intended for teams, this scenario will not only create a local project and git repository, but will also create a 
+Git bare in a remote location. 
+```
+dirt generate project --name PROJECT_NAME --location PATH --host HOST_NAME --bare-path PATH
+```
+
+*Example*
+We would like a new project:
+ - called "*Our Project*"
+ - saved in `~/projects/our_project`
+ - with a git bare repository saved on a machine called *dresden*, and in `/var/git/our_project.git` 
+ 
+So we'd use:
+
+```
+dirt generate project --name "Our Project" --location ~/projects/ --host dresden --bare-path /var/git/ 
+```
+
+####Local Bare Host
+Even if you're building solo, you should have a bare repository to act as a sort of backup. Besides, you never know if you'll gain 
+teammates, and having a bare ready to copy to a remote machine is very handy.   
+
+This is a lot like the remote machine scenario above, but we don't need to provide the `--host` or `--bare-path`.
+
+```
+dirt generate project --name PROJECT_NAME --location PATH
+```
+
+*Example*
+To have a new project called "*My New Project*" in `~/projects/my_new_project`, use:
+
+```
+dirt generate project --name "My New Project" --location ~/projects/
+```
+
+#### Full Listing
+```
+dirt generate [options]
+```
+
+This is the full listing of generation flags. 
+
+| Flag                   | Default Value       | Description                                                                        |
+| ---------------------- | -----------------   | ---------------------------------------------------------------------------------- |
+| `-n, --name NAME`      |                     | The human-readable name of the new project. Put it in quotes if you want spaces.   |
+| `-l, --location PATH`  | *Current directory* | The **parent** directory of the new project on the local machine.                  |
+| `-h, --host ADDRESS`   | `localhost`         | The IP address or hostname of the machine where the bare repository will be kept.  |
+| `-b, --bare-path PATH` | n/a                 | The **parent** directory of the new git bare on the host machine. _See also:_ `--host` |
+| `-u, --user NAME`      | *Your username*     | The username to be used to log into the host device. _See also:_ `--host`          |
+
+##Template variables
+In the template files, there are some times that you need dynamic data insertion. 
+
+These are the variables accessible to the template engine. Any instance of these tags will be replaced by the appropriate data.  
+
+| Tag                   | Description                                           | Default Value              | Example       |
+| --------------------- | ----------------------------------------------------- | -------------------------- | ------------- |
+| `<project_name>`      | The human-readable name of the project.               |                            | My Project    |
+| `<project_directory>` | The snake-case name of the project.                   |                            | my_project    |
+| `<project_module>`    | The module name of the project.                       |                            | MyProject     |
+| `<ruby_version>`      | The version of ruby that your project should support. | `ruby --version`           | 1.9.3         |
+| `<user_name>`         | The name of the user running dirt.                    | _your name_                | Bob Guardian  |
+| `<user_website>`      | The website to be associated with the project.        |                            | www.tenjin.ca |

data/core/contexts/commit_git_repository.rb

@@ -0,0 +1,56 @@
+#--
+# 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 CommitGitRepository < Dirt::Context
+    def initialize(project_path)
+      @project_path = Pathname.new(project_path)
+    end
+
+    def call
+      empty_dirs = Dir["#{@project_path}/**/*"].select do |d|
+        Dir.entries(d) == ['.', '..'] if File.directory?(d)
+      end
+
+      empty_dirs.each do |dir|
+        path = Pathname.new(dir) + '.gitkeep'
+
+        path.dirname.mkpath
+        FileUtils.touch(path)
+      end
+
+      Dir.glob("#{@project_path}/**/*", File::FNM_DOTMATCH).select do |f|
+        path = Pathname.new(f)
+        path.file? && !path.to_s.include?('/.git/')
+      end.each { |f| system(%Q{git --git-dir "#{@project_path}/.git" --work-tree "#{@project_path}" add -v "#{f}"}) }
+
+      system(%Q{git --git-dir "#{@project_path}/.git" --work-tree "#{@project_path}" commit -am "Project init with Dirt."})
+
+      system(%Q{git --git-dir "#{@project_path}/.git" --work-tree "#{@project_path}" push origin master})
+
+      'Comitting and pushing...'
+    end
+  end
+end
+
+

data/core/contexts/create_basic_face.rb

@@ -0,0 +1,60 @@
+#--
+# 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 CreateBasicFace < Dirt::Context
+    def initialize(root_path, face_name)
+      @root_path = Pathname.new(root_path)
+      @face_root = Pathname.new('faces') + face_name
+    end
+
+    def call
+      dirs = %w{integrations/support
+                integrations/step_definitions}
+
+      dirs.each do |f|
+        FileUtils.mkdir_p(@root_path + @face_root + f)
+      end
+
+      files_to_templates = {(@face_root + 'integrations/support/env.rb').to_s => 'template.env.rb'}
+
+      # this isn't a great way to find the dir, but at the time of writing, there isn't a nicer one -remiller
+      # templates_dir = Pathname.new(__FILE__).dirname
+
+      # files_to_templates.each do |f, t|
+      #   File.open((@face_root + f).to_s, 'w') do |file|
+      #     specified_content = File.read(Pathname.new('persist/templates/' + t).to_s)
+      #     specified_content.gsub!('<project_name>', @root_path.basename.to_s)
+      #
+      #     file.write(specified_content)
+      #   end
+      # end
+
+      Generating.new(files_to_templates).generate_templates(@root_path)
+
+      FileUtils.touch((@root_path + @face_root + 'integrations/step_definitions/given.rb').to_s)
+      FileUtils.touch((@root_path + @face_root + 'integrations/step_definitions/when.rb').to_s)
+      FileUtils.touch((@root_path + @face_root + 'integrations/step_definitions/then.rb').to_s)
+    end
+  end
+end

data/core/contexts/create_default_structure.rb

@@ -0,0 +1,57 @@
+#--
+# 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 CreateDefaultStructure < Dirt::Context
+    def initialize(project_path)
+      @project_root = Pathname.new(project_path)
+    end
+
+    def call
+      FileUtils.mkdir_p(@project_root)
+
+      dirs = %w{core/contexts
+                core/contexts/roles
+                core/models
+                core/tests/isolations
+                faces
+                persist}
+
+      dirs.each do |path|
+        FileUtils.mkdir_p(@project_root + path)
+      end
+
+      files_to_templates = {'.gitignore' => 'template.gitignore',
+                            'Gemfile' => 'template.Gemfile',
+                            "core/project_name.rb" => 'template.project_name.rb',
+                            'core/tests/behaviours/support/env.rb' => 'template.env.rb',
+                            'core/tests/behaviours/step_definitions/given.rb' => nil,
+                            'core/tests/behaviours/step_definitions/when.rb' => nil,
+                            'core/tests/behaviours/step_definitions/then.rb' => nil}
+
+      Generating.new(files_to_templates).generate_templates(@project_root)
+
+      "Created project structure in #{@project_root.to_s}."
+    end
+  end
+end