rake-distribute 1.0.0.20130321034642

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+gemspec
+
+group :development, :test do
+  gem "minitest", ">= 4.1.0"
+  gem "turn", ">= 0.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    rake-distribute (1.0.0.20121030083712)
+      diffy (>= 2.0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    diffy (2.1.0)
+    hoe (3.3.1)
+      rake (>= 0.8, < 11.0)
+    json (1.7.5)
+    json_pure (1.7.5)
+    minitest (4.3.1)
+    rake (10.0.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    turn (0.9.6)
+      ansi
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hoe (~> 3.1)
+  minitest (>= 4.1.0)
+  rake-distribute!
+  rdoc (~> 3.10)
+  rubyforge (>= 2.0.4)
+  turn (>= 0.8.3)

data/History.txt

@@ -0,0 +1,12 @@
+=== 1.0.0 / 2012-10-24
+
+* 3 minor enhancement
+
+  * add file install options
+  * erb item
+  * file item
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,17 @@
+.autotest
+Gemfile
+Gemfile.lock
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/rake/distribute.rb
+lib/rake/distribute/core.rb
+lib/rake/distribute/dsl.rb
+lib/rake/distribute/error.rb
+lib/rake/distribute/item.rb
+lib/rake/distribute/item/erbfile.rb
+lib/rake/distribute/item/file.rb
+lib/rake/distribute/version.rb
+test/minitest_helper.rb
+test/test_rake_distribute.rb

data/README.txt

@@ -0,0 +1,70 @@
+= rake-distribute
+
+* https://github.com/zhaocai/rake-distribute
+
+== DESCRIPTION:
+
+generate rake install/uninstall/diff/... tasks to distribute items (files, templates, directories, etc.) to difference locations.
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* `bundle install` can handle the required gems
+
+== INSTALL:
+
+* gem install rake-distribute
+
+== USAGE:
+
+    distribute :FileItem do
+      from "/path/from"
+      to "/path/to"
+    end
+
+    distribute :ErbFile do
+      from "/path/from"
+      to "/path/to"
+      with_context {:a => 1, :b => 2}
+    end
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012, Zhao Cai
+
+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,34 @@
+# -*- ruby -*-
+
+require 'rubygems' unless defined? Gem # rubygems is only needed in 1.8
+
+require 'hoe'
+
+# $DEBUG = true
+
+Hoe.plugin :gemspec
+Hoe.plugin :git
+Hoe.plugin :bundler
+Hoe.plugin :test
+# Hoe.plugin :rubyforge
+# Hoe.plugin :compiler
+# Hoe.plugin :email
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :inline
+# Hoe.plugin :perforce
+# Hoe.plugin :racc
+# Hoe.plugin :rcov
+# Hoe.plugin :seattlerb
+Hoe.plugin :rubygems
+
+Hoe.spec 'rake-distribute' do
+  self.rubyforge_name = 'zhaowu'
+  developer 'Zhao Cai', 'caizhaoff@gmail.com'
+  # self.rubyforge_name = 'rake-distributex' # if different than 'rake-distribute'
+
+  # extra_deps << ['diffy', '>= 2.0.9']
+end
+
+
+
+# vim: syntax=ruby

data/lib/rake/distribute.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'rake'
+require 'diffy'
+require 'rake/distribute/version'
+
+require 'rake/distribute/core'
+require 'rake/distribute/dsl'
+
+require 'rake/distribute/item'
+require 'rake/distribute/item/file'
+require 'rake/distribute/item/erbfile'

data/lib/rake/distribute/core.rb

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+require 'rake/dsl_definition'
+require 'singleton'
+
+module Rake::Distribute
+
+  class Core
+    include Singleton
+    include Rake::DSL
+
+    attr_accessor :build_dir
+    attr_accessor :distribute_config_file
+    attr_accessor :items
+
+
+    def initialize
+      @items = []
+
+      # unify task descriptions
+      namespace :distribute do
+        desc "distribute"
+        task :install
+
+        desc "build for distribution"
+        task :build
+
+        desc "clean temporary items"
+        task :clean
+
+        desc "clean all unnecessary items"
+        task :clobber => :clean
+
+        desc "diff the distributed from the source"
+        task :diff
+
+        desc "uninstall the distributed"
+        task :uninstall
+      end
+      task :clean => "distribute:clean"
+      task :clobber => "distribute:clobber"
+    end
+
+    def distribute(item_class, &block)
+      item = get_item_class(item_class).new(&block)
+      item.sanity?
+      item.define_tasks
+      @items << item
+    end
+
+    private
+
+    def get_item_class(item_class)
+      Rake::Distribute::Item.const_get(item_class)
+    end
+  end
+
+end
+

data/lib/rake/distribute/dsl.rb

@@ -0,0 +1,24 @@
+module Rake::Distribute
+  # Adds `distribute` method to the top-level namespace.
+  module DSL
+    # Distribute an item to some place
+    #
+    # ## Examples:
+    #
+    #   distribute :FileItem do
+    #     from "/path/from"
+    #     to "/path/to"
+    #   end
+    #
+    #   distribute :ErbFile do
+    #     from "/path/from"
+    #     to "/path/to"
+    #     with_context {:a => 1, :b => 2}
+    #   end
+    def distribute(item_class, &block)
+      Rake::Distribute::Core.instance.distribute(item_class, &block)
+    end
+  end
+end
+
+self.extend Rake::Distribute::DSL

data/lib/rake/distribute/error.rb

@@ -0,0 +1,3 @@
+module Rake::Distribute
+  class TimeoutError < RuntimeError ; end
+end

data/lib/rake/distribute/item.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+
+require 'rake/dsl_definition'
+
+module Rake::Distribute
+  module Item
+    @@serial_number = 0
+    def self.sn
+      @@serial_number += 1
+    end
+
+    class Base
+      include Rake::DSL
+
+      def initialize(&block)
+        instance_eval(&block) if block_given?
+      end
+
+      def from(source)
+        @src = source
+      end
+
+      def to(dest, options={})
+        @dest = dest
+      end
+
+      def diff(&block)
+        raise NotImplementedError
+      end
+
+      def sanity?
+        raise SyntaxError, "from: is not defined" unless defined? @src
+        raise SyntaxError, "to: is not defined" unless defined? @dest
+      end
+
+      def define_tasks
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/rake/distribute/item/erbfile.rb

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+require 'rake/distribute/item/file'
+require 'rake/ext/string'
+require 'erb'
+require 'ostruct'
+
+module Rake::Distribute
+  module Item
+
+    class ErbContext < OpenStruct
+      def get_binding
+        binding
+      end
+    end
+
+    class ErbFile < FileItem
+      def initialize(&block)
+        @context   = {}
+        @build_dir = File.join('build','distribute')
+        super
+      end
+
+      def sanity?
+        super
+        raise ArgumentError, "#{@src} does not exist!" unless File.exists?(@src)
+      end
+
+      def build_dir(folder)
+        @build_dir = folder
+      end
+
+      def with_context(context)
+        @context = context
+      end
+
+      def define_tasks
+        namespace "distribute" do
+          dest_dir = @dest.pathmap("%d")
+          directory dest_dir
+          directory @build_dir
+
+          build_file = File.join(@build_dir,
+                                 "#{Item.sn.to_s}-#{@src.pathmap('%n')}")
+          file build_file => @src do
+            File.open(build_file, 'w') do |f|
+              erb = ERB.new(File.read(@src))
+              f.write(erb.result(ErbContext.new(@context).get_binding))
+              f.flush
+            end
+          end
+
+          file @dest => build_file do
+            install build_file, @dest, @dest_options
+          end
+
+          task :build => [@build_dir, build_file]
+          task :install => [@build_dir, build_file, dest_dir, @dest]
+
+          task :uninstall do
+            safe_unlink @dest if File.exists?(@dest)
+          end
+
+          task :clean do
+            safe_unlink build_file if File.exists?(build_file)
+          end
+
+          task :clobber => [:clean] do
+            rmdir @build_dir
+          end
+
+          task :diff => [@build_dir, build_file] do
+            diff = Diffy::Diff.new(
+              @dest, build_file, :source => 'files', :allow_empty_diff => true
+            ).to_s(:text)
+
+            @diff_proc.call(@dest, build_file) unless diff.empty?
+          end
+        end
+      end
+
+    end
+
+  end
+end
+

data/lib/rake/distribute/item/file.rb

@@ -0,0 +1,54 @@
+require 'rake/distribute/item'
+require 'diffy'
+
+module Rake::Distribute
+  module Item
+
+    class FileItem < Base
+      def initialize(&block)
+        @diff_proc = Proc.new {|dest,src| puts "#{dest} differs from #{src}"}
+        super
+      end
+
+      def sanity?
+        super
+        raise ArgumentError, "#{@src} does not exist!" unless File.exists?(@src)
+      end
+
+      def to(dest, options={})
+        @dest = dest
+        @dest_options = options
+      end
+
+      def diff(&block)
+        @diff_proc = block if block_given?
+      end
+
+      def define_tasks
+        namespace "distribute" do
+          dest_folder = @dest.pathmap("%d")
+          directory dest_folder
+          file @dest => @src do
+            install @src, @dest, @dest_options
+          end
+
+          task :install => [dest_folder, @dest]
+
+          task :uninstall do
+            safe_unlink @dest
+          end
+
+          task :diff do
+            diff = Diffy::Diff.new(
+              @dest, @src, :source => 'files', :allow_empty_diff => true
+            ).to_s(:text)
+
+            @diff_proc.call(@dest, @src) unless diff.empty?
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/rake/distribute/version.rb

@@ -0,0 +1,3 @@
+module Rake::Distribute
+  VERSION = '1.0.0'
+end

data/test/minitest_helper.rb

@@ -0,0 +1,16 @@
+require 'turn/autorun'
+
+Turn.config do |c|
+  # use one of output formats:
+  # :outline  - turn's original case/test outline mode [default]
+  # :progress - indicates progress with progress bar
+  # :dotted   - test/unit's traditional dot-progress mode
+  # :pretty   - new pretty reporter
+  # :marshal  - dump output as YAML (normal run mode only)
+  # :cue      - interactive testing
+  c.format  = :outline
+  # turn on invoke/execute tracing, enable full backtrace
+  c.trace   = true
+  # use humanized test names (works only with :outline format)
+  c.natural = true
+end

data/test/test_rake_distribute.rb

@@ -0,0 +1,19 @@
+require 'minitest/autorun'
+require 'rake/distribute'
+# require "minitest_helper"
+
+
+class RakeDistributeTestCase < MiniTest::Unit::TestCase
+  def setup
+    self.extend Rake::Distribute::DSL
+  end
+
+  def test_sanity
+    assert_raises(ArgumentError) {
+      distribute :FileItem do
+        from "/non-exist/file/path"
+        to "/some/place"
+      end
+    }
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rake-distribute
+version: !ruby/object:Gem::Version
+  version: 1.0.0.20130321034642
+  prerelease: 
+platform: ruby
+authors:
+- Zhao Cai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: generate rake install/uninstall/diff/... tasks to distribute items (files,
+  templates, directories, etc.) to difference locations.
+email:
+- caizhaoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- .autotest
+- Gemfile
+- Gemfile.lock
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/rake/distribute.rb
+- lib/rake/distribute/core.rb
+- lib/rake/distribute/dsl.rb
+- lib/rake/distribute/error.rb
+- lib/rake/distribute/item.rb
+- lib/rake/distribute/item/erbfile.rb
+- lib/rake/distribute/item/file.rb
+- lib/rake/distribute/version.rb
+- test/minitest_helper.rb
+- test/test_rake_distribute.rb
+homepage: https://github.com/zhaocai/rake-distribute
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: zhaowu
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: generate rake install/uninstall/diff/..
+test_files:
+- test/test_rake_distribute.rb
+has_rdoc: