not-quite-submodules 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "versionomy", "~> 0.4.4"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.2.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+  gem "reek", "~> 1.2.8"
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    blockenspiel (0.4.5)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.6)
+    multi_json (1.5.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    reek (1.2.13)
+      ripper_ruby_parser (~> 0.0.7)
+      ruby2ruby (~> 1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ripper_ruby_parser (0.0.8)
+      sexp_processor (~> 3.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.2.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    versionomy (0.4.4)
+      blockenspiel (>= 0.4.5)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.2.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  reek (~> 1.2.8)
+  rspec (~> 2.8.0)
+  simplecov
+  versionomy (~> 0.4.4)
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Lucas Jenss
+
+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,103 @@
+# not-quite-submodules
+
+This gem can be used to automatically check out and update a git repository pretty much anywhere. I wrote it because I wanted to be able to clone a project repository, and then automatically fetch some deployment capistrano tasks, keeping them up to date whenever I run a `cap` command. But you can use it anywhere else as well, it's not limited to capistrano or even being inside a git repository.
+
+
+
+## How it works
+
+not-quite-submodules simply clones the specified repository, checks out the latest tag (by version number!) and copies the content to the specified `config_dir`.
+
+There _must_ be at least one tag in the configuration repository, otherwise the update will fail. The version comparison/ordering is done using the [Versionomy](https://github.com/dazuma/versionomy) gem, for example:
+
+    v1.0 < v1.0.1 < v1.1 < v1.1.1 < ...
+
+For your convenience, not-quite-submodules also generates a `.gitignore` file in the `config_dir` which ignores all content copied from the configuration repository.
+
+By default, the gem will try to update the configuration repository once every 24 hours. You may force an update by setting the `FORCE_UPDATE` environment variable to a truthy value. From the command line, for example:
+
+    FORCE_UPDATE=1 cap deploy
+
+
+
+## How to set up for capistrano?
+
+You'll need a new git repository containing your configuration. Lets say you currently use the following directory structure in your projects:
+
+    project/
+        Cap
+        config/
+            capistrano/
+                deploy.rb
+                util/
+                    important.rb
+                    stuff.rb
+                project.rb
+                stages/
+                    production.rb
+                    staging.rb
+        [...]
+
+Let us also assume that everything in the `util/` folder as well as `deploy.rb` is never modified, that is, the project specific configuration resides solely in `stages/` and `project.rb`. You'd now create a new git repository containing the following:
+
+    deploy.rb
+    util/
+        important.rb
+        stuff.rb
+
+Then you'd simply remove these files from your project structure, resulting in:
+
+    project/
+        Cap
+        config/
+            capistrano/
+                project.rb
+                stages/
+                    production.rb
+                    staging.rb
+        [...]
+
+Now you want to add the following lines to the beginning of your `Cap` file:
+
+    require 'not-quite-submodules'
+    NotQuiteSubmodules.initialize(
+        "git@github.com:you-on-github/capistrano-configuration.git",
+        :target_path => "config/capistrano",
+        :temp_path => "config/.config_repo"
+    )
+
+
+
+## The `#initialize` method
+
+`initialize` is pretty much everything you'll ever see of not-quite-submodules. It takes the repository to be cloned as its first parameter and allows you to specify the following configuration parameters:
+
+* `:target_path` => This is where you'd like the files from the repository to end up in the end.
+* `:temp_path` => The directory to which the repository is cloned. Note that this directory is not deleted after the files have been updated so that the entire repository does not need to be cloned again next time. Therefore it might be a good idea to add it to your `.gitignore` file.
+
+
+
+## Caveats
+
+* not-quite-submodules does not currently **delete** any files, it only overwrites updated files or creates newly created ones.
+
+
+
+## TODO
+
+* Support file deletion
+
+
+
+
+## Boring legal stuff (read: License)
+
+Copyright (C) 2013 Lucas Jenß
+
+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/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "not-quite-submodules"
+  gem.homepage = "http://github.com/x3ro/not-quite-submodules"
+  gem.license = "MIT"
+  gem.summary = %Q{This gem can be used to automatically clone and update a git repository.}
+  gem.description = %Q{This gem can be used to automatically clone an update a git repository, relying on tags to see if a newer version of the repository is available.}
+  gem.email = "lucas@x3ro.de"
+  gem.authors = ["Lucas Jenss"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/not-quite-submodules.rb

@@ -0,0 +1,152 @@
+require 'fileutils'
+require 'versionomy'
+require 'tmpdir'
+require 'digest/sha1'
+
+class NotQuiteSubmodules
+  class << self
+    # Update configuration repository every day
+    UPDATE_INTERVAL = 60 * 60 * 24
+
+    def initialize(repository, target_path, args = {})
+      args[:target_path] = target_path
+
+      if args[:temp_path].nil?
+        tmp_name = (Digest::SHA1.hexdigest repository)
+        args[:temp_path] = "#{Dir.tmpdir}/#{tmp_name[0..8]}"
+      end
+
+      if !File.directory? args[:temp_path]
+        clone_repository(repository, args[:temp_path])
+      elsif repository_needs_update?(args[:temp_path])
+        update_repository(args[:temp_path])
+      end
+
+      tags = get_repository_tags(args[:temp_path]).map { |x| Versionomy.parse(x) }.sort
+      if configuration_needs_update?(args[:temp_path], tags)
+        update_target_path(args[:temp_path], args[:target_path], tags)
+      end
+    end
+
+private
+
+    def configuration_needs_update?(temp_path, tags)
+      return true if !ENV["FORCE_UPDATE"].nil?
+      current_tag = get_current_tag(temp_path)
+      return true if current_tag.nil?
+      current_tag < tags.last
+    end
+
+    # Checks out the latest tag and copies all files to the target path.
+    def update_target_path(temp_path, target_path, tags)
+      update_to = tags.last
+      tell("About to update target path to tag '#{update_to}'")
+
+      in_dir_do(temp_path) do
+        execute_command("git checkout #{update_to}")
+      end
+      set_current_tag(temp_path, update_to)
+      tell("Updated to '#{update_to}'")
+
+      tell("Copying updated files to '#{target_path}'")
+      execute_command("cp -rf #{temp_path}/* #{target_path}")
+
+      write_gitignore(temp_path, target_path)
+
+      tell("Finished updating '#{target_path}' to '#{update_to}'")
+    end
+
+    # Writes a .gitignore file which ignores all files copied from the repository.
+    def write_gitignore(temp_path, target_path)
+      tell("Updating #{target_path}/.gitignore")
+      files = in_dir_do(temp_path) { Dir.glob("*") }
+      files.push(".gitignore")
+      in_dir_do(target_path) do
+        File.open(".gitignore", 'w+') { |f| f.write(files.join("\n")) }
+      end
+    end
+
+    # The file that contains the currently checked out tag (that is, the last tag
+    # whose contents where copied to the configuration directory)
+    def tag_file(temp_path)
+      "#{temp_path}/.CURRENT_TAG"
+    end
+
+    def get_current_tag(temp_path)
+      dir = tag_file(temp_path)
+      return nil if !File.exists?(dir)
+      lines = File.read(dir).split("\n")
+      return nil if lines.length < 1
+      Versionomy.parse(lines.first)
+    end
+
+    def set_current_tag(temp_path, tag)
+      File.open(tag_file(temp_path), 'w+') { |f| f.write(tag) }
+    end
+
+    # Returns an array of tags specified for the cloned configuration repository
+    def get_repository_tags(temp_path)
+      in_dir_do(temp_path) do
+        out = execute_command("git tag")
+        raise "Repository in path #{temp_path} is not a valid Git repository" if $? != 0
+
+        tags = out.split("\n")
+        raise "Repository in path #{temp_path} does not contain any tags!" if tags.length < 1
+
+        tags
+      end
+    end
+
+    def clone_repository(repository, temp_path)
+      tell "Cloning repository #{repository} to #{temp_path}"
+      execute_command("git clone #{repository} #{temp_path}")
+    end
+
+    # Determines if the repository needs to be updated by checking when it was last
+    # touched (by the #update_repository method)
+    def repository_needs_update?(temp_path)
+      return true if !ENV["FORCE_UPDATE"].nil?
+      (Time.now - File.mtime(temp_path)) > UPDATE_INTERVAL
+    end
+
+    # Pull the latest contents (including tags) for the repository
+    def update_repository(temp_path)
+      in_dir_do(temp_path) do
+        tell "Updating local configuration repository at '#{temp_path}'"
+        execute_command("git checkout master")
+        execute_command("git pull origin master --tags")
+
+        head = execute_command("git rev-parse HEAD")[0,8]
+        tell("Updated local configuration repository to #{head}")
+      end
+      execute_command("touch #{temp_path}")
+    end
+
+    def tell(text)
+      if @wrote_banner.nil?
+        puts "[NotQuiteSubmodules]"
+        @wrote_banner = true
+      end
+
+      puts "\t=> #{text}"
+    end
+
+    # Switches to the specified directory, executes the given block and then
+    # switches the working directory back to where it was before.
+    def in_dir_do(temp_path, &block)
+      cwd = Dir.pwd
+      Dir.chdir(temp_path)
+      out = block.call
+      Dir.chdir(cwd)
+      out
+    end
+
+    # Executes the given shell command in the current working directory, and throws an
+    # exception in case the command failed (exit status != 0)
+    def execute_command(command)
+      out = `#{command} 2>&1`
+      raise "There was an error executing '#{command}'. Output: \n #{out} \n" if $? != 0
+      out
+    end
+  end
+end

data/not-quite-submodules.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "not-quite-submodules"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lucas Jenss"]
+  s.date = "2013-04-05"
+  s.description = "This gem can be used to automatically clone an update a git repository, relying on tags to see if a newer version of the repository is available."
+  s.email = "lucas@x3ro.de"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/not-quite-submodules.rb",
+    "not-quite-submodules.gemspec"
+  ]
+  s.homepage = "http://github.com/x3ro/not-quite-submodules"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "This gem can be used to automatically clone and update a git repository."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<versionomy>, ["~> 0.4.4"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
+    else
+      s.add_dependency(%q<versionomy>, ["~> 0.4.4"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.2.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<reek>, ["~> 1.2.8"])
+    end
+  else
+    s.add_dependency(%q<versionomy>, ["~> 0.4.4"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.2.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<reek>, ["~> 1.2.8"])
+  end
+end
+

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: not-quite-submodules
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Lucas Jenss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: versionomy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+description: This gem can be used to automatically clone an update a git repository,
+  relying on tags to see if a newer version of the repository is available.
+email: lucas@x3ro.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/not-quite-submodules.rb
+- not-quite-submodules.gemspec
+homepage: http://github.com/x3ro/not-quite-submodules
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4333987324619040065
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem can be used to automatically clone and update a git repository.
+test_files: []