filander 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Johannes J. Schmidt
+
+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.rdoc

@@ -0,0 +1,17 @@
+= filander
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Johannes J. Schmidt. See LICENSE for details.

data/lib/filander.rb

@@ -0,0 +1,77 @@
+require 'fileutils'
+require 'filander/actions/base'
+require 'filander/actions/cmd'
+require 'filander/actions/copy_directory'
+require 'filander/actions/copy_file'
+require 'filander/actions/create_file'
+require 'filander/actions/empty_directory'
+require 'filander/actions/inject_into_file'
+require 'filander/actions/inside'
+require 'filander/actions/template'
+
+module Filander
+  def self.included(base)
+    base.class_eval do
+      def self.source_root(dirname)
+        Filander.source_root = dirname
+      end
+
+      def self.destination_root(dirname)
+        Filander.destination_root = dirname
+      end
+
+      def self.quiet(value)
+        Filander.quiet = value
+      end
+
+      # can be :pretend, :skip, :force
+      def self.behavior(value)
+        Filander.behavior = value
+      end
+    end
+  end
+
+  class << self
+    attr_reader :source_root_stack, :destination_root_stack
+    attr_accessor :quiet, :behavior
+
+    def source_root=(dirname)
+      add_source_root dirname
+    end
+
+    def source_root
+      @source_root_stack ||= []
+      @source_root_stack.last
+    end
+
+    def destination_root=(dirname)
+      add_destination_root dirname
+    end
+
+    def destination_root
+      @destination_root_stack ||= []
+      @destination_root_stack.last
+    end
+
+    private
+
+    def add_source_root(dirname)
+      @source_root_stack ||= []
+      @source_root_stack.push dirname
+    end
+
+    def add_destination_root(dirname)
+      @destination_root_stack ||= []
+      @destination_root_stack.push dirname
+    end
+  end
+
+  include Cmd
+  include CopyDirectory
+  include CopyFile
+  include CreateFile
+  include EmptyDirectory
+  include InjectIntoFile
+  include Inside
+  include Template
+end

data/lib/filander/actions/base.rb

@@ -0,0 +1,117 @@
+module Filander
+  module Base
+    def join_source(filename = nil)
+      join Filander.source_root, filename
+    rescue
+      raise 'Please specify source_root'
+    end
+
+    def join_destination(filename = nil)
+      join Filander.destination_root, filename
+    rescue
+      raise 'Please specify destination_root'
+    end
+
+    def create_directory_for(destination = nil)
+      dest_dir = File.dirname(join_destination(destination))
+
+      FileUtils.mkdir_p dest_dir unless File.exists?(dest_dir)
+    end
+
+    def with_report(destination, content = nil)
+      filename = join_destination(destination)
+
+      skip = Filander.behavior == :skip
+      if File.exists?(filename)
+        if File.file?(filename) && content == File.read(filename)
+          report :identical, destination
+          skip = true
+        elsif File.directory?(filename) && content == entries(filename)
+          report :identical, destination
+          skip = true
+        else
+          case Filander.behavior
+          when :force
+            report :force, destination
+          when :skip
+            report :skip, destination
+          else
+            file = $terminal.color(filename, :bold) if defined? $terminal
+            skip = nil
+            puts 'Overwrite %s [Nyc]?' % file
+            until !skip.nil?
+              answer = STDIN.gets.chomp.downcase
+              case answer
+              when '', 'n', 'no'
+                skip = true
+              when 'y', 'yes'
+                skip = false
+              when 'c', 'cancel'
+                exit
+              else
+                puts 'Please anwer either [Y]es, [N]o or [C]ancel'
+                skip = nil
+              end
+            end
+            report skip ? :skip : :force, destination
+          end
+        end
+      else
+        report :create, destination
+      end
+
+      yield unless skip || Filander.behavior == :pretend
+    end
+
+    def report(verb, filename)
+      return if Filander.quiet
+
+      # TODO: make this nice
+      if Filander.destination_root
+        begin
+          name = Pathname.new(File.expand_path(join_destination(filename))).relative_path_from(Pathname.new(File.expand_path(Filander.destination_root_stack.first)))
+        rescue
+          name = filename
+        end
+      else
+        name = filename
+      end
+
+      # left: cyan
+      color = case verb
+              when :create
+                :green
+              when :force, :skip
+                :yellow
+              when :conflict
+                :red
+              when :execute
+                :magenta
+              else
+                :blue
+              end
+
+      verb = verb.to_s.rjust(12)
+      verb = $terminal.color(verb, :bold, color) if defined? $terminal
+
+      puts '%s  %s' % [verb, name]
+    end
+
+    def entries(dirname)
+      basename = Pathname.new(dirname)
+      array = Dir[File.join(dirname, '**')]
+      array.map! { |f| Pathname.new f }
+      array.map! { |p| p.relative_path_from basename }
+      array
+    end
+
+    private
+
+    def join(root, filename)
+      return Filander.source_root if filename.nil?
+      return filename if filename =~ /^\//
+      return File.expand_path(filename) if filename =~ /^~/
+      File.join root, filename
+    end
+  end
+end

data/lib/filander/actions/cmd.rb

@@ -0,0 +1,12 @@
+module Filander
+  module Cmd
+    include Base
+
+    def cmd(command)
+      report :execute, command
+      unless Filander.behavior == :pretend
+        system command
+      end
+    end
+  end
+end

data/lib/filander/actions/copy_directory.rb

@@ -0,0 +1,17 @@
+module Filander
+  module CopyDirectory
+    include Base
+
+    def copy_directory(source, destination = source)
+      create_directory_for destination
+      filename = join_source(source)
+      raise "Source file `#{filename}' does not exist" unless File.exists?(filename)
+
+      dest = join_destination(destination)
+      with_report destination, entries(filename) do
+        FileUtils.rm_rf dest
+        FileUtils.cp_r filename, dest
+      end
+    end
+  end
+end

data/lib/filander/actions/copy_file.rb

@@ -0,0 +1,16 @@
+module Filander
+  module CopyFile
+    include Base
+
+    def copy_file(source, destination = source)
+      create_directory_for destination
+      filename = join_source(source)
+      raise "Source file `#{filename}' does not exist" unless File.exists?(filename)
+
+      content = File.read(filename) rescue nil
+      with_report destination, content do
+        FileUtils.cp filename, join_destination(destination)
+      end
+    end
+  end
+end

data/lib/filander/actions/create_file.rb

@@ -0,0 +1,13 @@
+module Filander
+  module CreateFile
+    include Base
+
+    def create_file(destination, content)
+      create_directory_for destination
+
+      with_report destination, content do
+        File.open(join_destination(destination), "w") { |file| file << content }
+      end
+    end
+  end
+end

data/lib/filander/actions/empty_directory.rb

@@ -0,0 +1,16 @@
+module Filander
+  module EmptyDirectory
+    include Base
+
+    def empty_directory(destination)
+      dest_dir = join_destination(destination)
+
+      if File.exists?(dest_dir)
+        report :exist, destination
+      else
+        report :create, destination
+        FileUtils.mkdir_p dest_dir
+      end
+    end
+  end
+end

data/lib/filander/actions/inject_into_file.rb

@@ -0,0 +1,39 @@
+module Filander
+  module InjectIntoFile
+    include Base
+
+    def inject_into_file(destination, *args, &block)
+      filename = join_destination(destination)
+
+      if block_given?
+        data, config = block.call, args.shift
+      else
+        data, config = args.shift, args.shift
+      end
+
+      position = config[:after] ? :after : :before
+      flag     = config[position]
+      flag     = Regexp.escape(flag) unless flag.is_a?(Regexp)
+
+      replacement = if position == :after
+                      '\0' + data
+                    else
+                      data + '\0'
+                    end
+
+      present = if position == :after
+                  /#{flag}#{Regexp.escape data}/
+                else
+                  /#{Regexp.escape data}#{flag}/
+                end
+
+      content = File.read(filename) if File.file?(filename)
+      content ||= ''
+      content.gsub!(/#{flag}/, replacement) unless content =~ present
+
+      with_report destination, content do
+        File.open(filename, "w") { |file| file << content }
+      end
+    end
+  end
+end

data/lib/filander/actions/inside.rb

@@ -0,0 +1,20 @@
+module Filander
+  module Inside
+    include Base
+
+    def inside(source, destination = source, &block)
+      dest_dir = join_destination(destination)
+      dirname = join_source(source)
+
+      FileUtils.mkdir_p dest_dir unless File.exists?(dest_dir)
+
+      FileUtils.cd(dirname) do
+        Filander.destination_root_stack.push(dest_dir)
+        Filander.source_root_stack.push(dirname)
+        yield
+        Filander.source_root_stack.pop
+        Filander.destination_root_stack.pop
+      end
+    end
+  end
+end

data/lib/filander/actions/template.rb

@@ -0,0 +1,17 @@
+require 'erb'
+
+module Filander
+  module Template
+    include Base
+
+    def template(source, destination = source)
+      create_directory_for destination
+      context = instance_eval('binding')
+      content = ERB.new(File.read(join_source(source)), nil, '-').result(context)
+
+      with_report destination, content do
+        File.open(join_destination(destination), "w") { |file| file << content }
+      end
+    end
+  end
+end

data/spec/filander/actions/base_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Filander" do
+  describe "Base" do
+    include Filander::Base
+
+    describe "join_source" do
+      it "should return source_root" do
+        join_source.should == Filander.source_root
+      end
+
+      it "should raise if source_root is nil" do
+        lambda { join_source 'abc' }.should raise_error
+      end
+
+      it "should join source_root and filename" do
+        Filander.source_root = 'abc'
+        join_source('def').should == 'abc/def'
+        Filander.source_root = nil
+      end
+    end
+
+    describe "join_destination" do
+      it "should return destination_root" do
+        join_destination.should == Filander.destination_root
+      end
+
+      it "should raise if destination_root is nil" do
+        lambda { join_destination 'abc' }.should raise_error
+      end
+
+      it "should join destination_root and filename" do
+        Filander.destination_root = 'abc'
+        join_destination('def').should == 'abc/def'
+        Filander.destination_root = nil
+      end
+    end
+
+    describe "create_directory_for" do
+      it "should raise if destination_root is nil" do
+        lambda { create_directory_for 'abc' }.should raise_error
+      end
+
+      describe "with source and destination" do
+        before do
+          setup_roots
+        end
+
+        after do
+          teardown_roots
+        end
+
+        it "should create destination directory" do
+          create_directory_for('mydir/myfile')
+          File.directory?(join_destination('mydir')).should be_true
+        end
+      end
+    end
+  end
+end

data/spec/filander/actions/copy_file_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Filander" do
+  describe "CopyFile" do
+    include Filander::CopyFile
+
+    before do
+      setup_roots
+    end
+
+    after do
+      teardown_roots
+    end
+
+    it "should copy myfile to otherfile" do
+      copy_file 'myfile', 'otherfile'
+      File.file?(join_destination('otherfile')).should be_true
+    end
+
+    it "should copy file" do
+      copy_file 'myfile'
+      File.file?(join_destination('myfile')).should be_true
+    end
+
+    it "should copy file and create directory" do
+      copy_file 'mydir/myfile'
+      File.file?(join_destination('mydir/myfile')).should be_true
+    end
+  end
+end

data/spec/filander/actions/create_file_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Filander" do
+  describe "CreateFile" do
+    include Filander::CreateFile
+
+    before do
+      setup_roots
+    end
+
+    after do
+      teardown_roots
+    end
+
+    it "should create file" do
+      create_file 'myfile', 'data'
+      File.file?(join_destination('myfile')).should be_true
+    end
+
+    it "should create file and subdir" do
+      create_file 'mydir/myfile', 'data'
+      File.directory?(join_destination('mydir')).should be_true
+      File.file?(join_destination('mydir/myfile')).should be_true
+    end
+
+    it "should write content" do
+      create_file 'myfile', 'data'
+      File.read(join_destination('myfile')).should == 'data'
+    end
+  end
+end

data/spec/filander/actions/empty_directory_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Filander" do
+  describe "EmptyDirectory" do
+    include Filander::EmptyDirectory
+
+    before do
+      setup_roots
+    end
+
+    after do
+      teardown_roots
+    end
+
+    it "should create empty directory" do
+      empty_directory 'mydir'
+      File.directory?(join_destination('mydir')).should be_true
+    end
+
+    it "should create empty pending directories" do
+      empty_directory 'mydir/mydir'
+      File.directory?(join_destination('mydir/mydir')).should be_true
+    end
+  end
+end

data/spec/filander/actions/inject_into_file_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Filander" do
+  describe "InjectIntoFile" do
+    include Filander::InjectIntoFile
+
+    before do
+      setup_roots
+      FileUtils.mkdir_p Filander.destination_root
+      @filename = join_destination('myfile')
+      File.open(@filename, 'w') { |file| file << 'data' }
+    end
+
+    after do
+      teardown_roots
+    end
+
+    it "should inject data before specified content into file" do
+      inject_into_file 'myfile', 'mydata', :before => 'data'
+      File.read(@filename).should == "mydatadata"
+    end
+
+    it "should inject data after specified content into file" do
+      inject_into_file 'myfile', 'mydata', :after => 'data'
+      File.read(@filename).should == "datamydata"
+    end
+
+    it "should inject data from block before specified content into file" do
+      inject_into_file 'myfile', :before => 'data' do
+        'mydata'
+      end
+      File.read(@filename).should == "mydatadata"
+    end
+
+    it "should inject data from block after specified content into file" do
+      inject_into_file 'myfile', :after => 'data' do
+        'mydata'
+      end
+      File.read(@filename).should == "datamydata"
+    end
+
+    it "should inject data before specified content via regexp into file" do
+      inject_into_file 'myfile', 'mydata', :before => /ta/
+      File.read(@filename).should == "damydatata"
+    end
+  end
+end

data/spec/filander/actions/inside_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Filander" do
+  describe "Inside" do
+    include Filander::Inside
+
+    before do
+      setup_roots
+    end
+
+    after do
+      teardown_roots
+    end
+
+    it "should change to source directory" do
+      inside 'mydir' do
+        Dir.pwd.should == File.join(SOURCE_ROOT, 'mydir')
+      end
+    end
+
+    it "should change to source directory otherdir" do
+      inside 'mydir', 'otherdir' do
+        Dir.pwd.should == File.join(SOURCE_ROOT, 'mydir')
+      end
+    end
+
+    it "should set destination directory" do
+      inside 'mydir' do
+        Filander.destination_root == File.join(DESTINATION_ROOT, 'mydir')
+      end
+    end
+
+    it "should set destination directory to otherdir" do
+      inside 'mydir', 'otherdir' do
+        Filander.destination_root == File.join(DESTINATION_ROOT, 'otherdir')
+      end
+    end
+
+    it "should reset pwd" do
+      pwd = FileUtils.pwd
+      inside 'mydir' do
+      end
+      FileUtils.pwd.should == pwd
+    end
+
+    it "should create destination directory" do
+      inside 'mydir' do
+      end
+      File.directory?(join_destination('mydir')).should be_true
+    end
+  end
+end

data/spec/filander/actions/template_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Filander" do
+  describe "Template" do
+    include Filander::Template
+
+    def data
+      "mydata"
+    end
+
+    before do
+      setup_roots
+    end
+
+    after do
+      teardown_roots
+    end
+
+    it "should create myfile" do
+      template 'mytemplate', 'myfile'
+      File.file?(join_destination('myfile')).should be_true
+    end
+
+    it "should create file" do
+      template 'mytemplate'
+      File.file?(join_destination('mytemplate')).should be_true
+    end
+
+    it "should create file and subdir" do
+      template 'mydir/mytemplate'
+      File.directory?(join_destination('mydir')).should be_true
+      File.file?(join_destination('mydir/mytemplate')).should be_true
+    end
+
+    it "should write erb evaluated content" do
+      template 'mytemplate'
+      File.read(join_destination('mytemplate')).should == "mydata\n"
+    end
+  end
+end

data/spec/filander_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Filander" do
+  describe "source_root" do
+    it "should be accessible" do
+      Filander.source_root = 'abc'
+      Filander.source_root.should == 'abc'
+      Filander.source_root = nil
+    end
+  end
+
+  describe "destination_root" do
+    it "should be accessible" do
+      Filander.destination_root = 'abc'
+      Filander.destination_root.should == 'abc'
+      Filander.destination_root = nil
+    end
+  end
+
+  describe "actions" do
+    it "should include CopyFile" do
+      Filander.included_modules.should include(Filander::CopyFile)
+    end
+
+    it "should include CreateFile" do
+      Filander.included_modules.should include(Filander::CreateFile)
+    end
+
+    it "should include EmptyDirectory" do
+      Filander.included_modules.should include(Filander::EmptyDirectory)
+    end
+
+    it "should include InjectIntoFile" do
+      Filander.included_modules.should include(Filander::InjectIntoFile)
+    end
+
+    it "should include Inside" do
+      Filander.included_modules.should include(Filander::Inside)
+    end
+
+    it "should include Template" do
+      Filander.included_modules.should include(Filander::Template)
+    end
+  end
+end

data/spec/source/mydir/myfile

@@ -0,0 +1 @@
+data

data/spec/source/mydir/mytemplate

@@ -0,0 +1 @@
+<%= data %>

data/spec/source/myfile

@@ -0,0 +1 @@
+data

data/spec/source/mytemplate

@@ -0,0 +1 @@
+<%= data %>

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'filander'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+SOURCE_ROOT      = File.expand_path(File.dirname(__FILE__) + '/source')
+DESTINATION_ROOT = File.expand_path(File.dirname(__FILE__) + '/destination')
+
+Filander.quiet    = true
+Filander.behavior = :force
+
+def setup_roots
+  Filander.source_root      = SOURCE_ROOT
+  Filander.destination_root = DESTINATION_ROOT
+end
+
+def teardown_roots
+  FileUtils.rm_rf(Filander.destination_root)
+  Filander.source_root      = nil
+  Filander.destination_root = nil
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: filander
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Johannes J. Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Helps dealing with files and directories
+email: schmidt@netzmerk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/filander.rb
+- lib/filander/actions/base.rb
+- lib/filander/actions/cmd.rb
+- lib/filander/actions/copy_directory.rb
+- lib/filander/actions/copy_file.rb
+- lib/filander/actions/create_file.rb
+- lib/filander/actions/empty_directory.rb
+- lib/filander/actions/inject_into_file.rb
+- lib/filander/actions/inside.rb
+- lib/filander/actions/template.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/jo/filander
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: File manipulation tools
+test_files: 
+- spec/filander_spec.rb
+- spec/spec_helper.rb
+- spec/filander/actions/inside_spec.rb
+- spec/filander/actions/copy_file_spec.rb
+- spec/filander/actions/inject_into_file_spec.rb
+- spec/filander/actions/template_spec.rb
+- spec/filander/actions/empty_directory_spec.rb
+- spec/filander/actions/create_file_spec.rb
+- spec/filander/actions/base_spec.rb
+- spec/source/myfile
+- spec/source/mydir/myfile
+- spec/source/mydir/mytemplate
+- spec/source/mytemplate
+- spec/spec.opts