skeleton_creator 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+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,40 @@
+= File structure creator
+
+Script to facilitate quick and easy creation of complex directory/file structures.
+
+1. Create a YAML directory structure file 
+  Structure should be similar to the examples in config-files
+
+  By default any leaf node results in a File being created. 
+  To override this, postfix with DIR, fx
+  - my_dir DIR 
+
+  If you want all nodes in a tree to be created as dirs, supply a meta: in the root of the tree 
+  meta: ONLY_DIRS 
+
+  This will ensure all nodes in the tree are treated as dirs
+    
+1. Run it!
+  require 'skeleton_creator'
+
+  runner = FileSystem::Runner.new file_name [, options]
+  runner.run root_dir [, options]
+
+Fx to generate the skeleton structure inside ~/testing as per the apps.yml file 
+  runner = FileSystem::Runner.new 'apps.yml'
+  runner.run "~/testing"
+
+
+== 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 Kristian Mandrup. See LICENSE for details.

data/lib/file_system/directory.rb

@@ -0,0 +1,10 @@
+require 'fileutils'
+
+module FileSystem
+  class Directory < FakeDirectory
+    def create
+      FileUtils.mkdir_p name
+    end
+
+  end
+end

data/lib/file_system/fake_directory.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+
+module FileSystem
+  class FakeDirectory
+
+    attr_accessor :name
+    def initialize(traverser, name)
+      traverser.visit_dir(name)      
+      @name = traverser.current_dir
+    end
+  
+    def create
+      puts "DIR: #{name}"
+    end
+  
+    def is_file?
+      false
+    end
+
+    def is_dir?
+      true
+    end    
+    
+  end
+end

data/lib/file_system/fake_file.rb

@@ -0,0 +1,22 @@
+module FileSystem
+  class FakeFile
+    attr_accessor :name    
+    
+    def initialize(traverser, name)
+      @name = ::File.join(traverser.current_dir, name)
+    end
+
+    def create
+      puts "FILE: #{name}"
+    end
+
+    def is_file?
+      true
+    end
+
+    def is_dir?
+      false
+    end
+    
+  end  
+end

data/lib/file_system/file.rb

@@ -0,0 +1,9 @@
+module FileSystem
+  class File < FakeFile
+    
+    def create
+      FileUtils.touch name
+    end
+    
+  end  
+end

data/lib/file_system/traverser.rb

@@ -0,0 +1,92 @@
+require 'file_system/fake_file' 
+require 'file_system/fake_directory'
+require 'file_system/file' 
+require 'file_system/directory' 
+
+
+module FileSystem
+  class Traverser
+    attr_accessor :root_dir, :dir_stack, :options
+    
+    def initialize(root_dir, options = {})
+      @root_dir ||= root_dir
+      @dir_stack = []
+      @options = options
+    end
+
+    def traverse(obj, &blk)
+      case obj
+      when Hash
+        handle_hash(obj, &blk)
+      when Array
+        handle_list(obj, &blk)
+      else
+        handle_single(obj, &blk)
+      end
+    end
+
+    def current_dir
+      ::File.join(root_dir, dir_stack.join('/'))
+    end
+    
+    def visit_dir(name)
+      dir_stack.push name
+    end      
+
+    def leave_dir
+      dir_stack.pop
+    end      
+
+
+  protected
+    def handle_hash(obj, &blk)
+      # Forget keys because I don't know what to do with them
+      obj.each do |dir_name, dir_content|
+        options.merge! parse_meta(dir_name, dir_content)                          
+        blk.call(create_directory dir_name) if !(options && options[:dirs_only]) 
+        options.delete :dirs_only
+        traverse(dir_content, &blk)
+        leave_dir      
+      end
+    end
+
+    def handle_list(obj, &blk)
+      obj.each do |dir_content| 
+        traverse(dir_content, &blk)
+      end
+    end
+
+    def handle_single(obj, &blk)
+      if obj
+        file_name = obj      
+        if file_name =~ /DIR/ || 
+          dir_name = file_name.gsub(/DIR/, '').strip
+          blk.call(create_directory dir_name)
+          leave_dir      
+        else        
+          blk.call(create_file file_name)          
+        end
+      end
+    end
+    
+    def create_directory(name)
+      return FileSystem::FakeDirectory.new(self, name) if options[:fake]
+      FileSystem::Directory.new(self, name)         
+    end
+
+    def create_file(name)
+      return FileSystem::FakeFile.new(self, name) if options[:fake]
+      FileSystem::File.new(self, name)         
+    end
+  
+    def parse_meta(key, value)
+      return {dirs_only: true} if key == 'meta' && value == 'ONLY_DIRS'             
+      {}
+    end
+
+    def dirs_only?
+      options && options[:dirs_only]
+    end
+    
+  end
+end

data/lib/skeleton_creator.rb

@@ -0,0 +1,28 @@
+require 'yaml' 
+require 'file_system/traverser' 
+
+# filename = 'structures/development/directory.yml'
+
+module FileSystem  
+  class Runner   
+    attr_accessor :yml_content, :options
+    
+    def initialize(filename, options = false)      
+      @yml_content = YAML.load_file(filename)
+      @options = options
+    end
+    
+    def run(root_dir, options = {})  
+      @options = options if !options.nil?      
+      root = root_dir.gsub /~/, "#{ENV['HOME']}"
+      yml_content.each do |key, value|
+        if key == 'DIRECTORY'
+          traverser = FileSystem::Traverser.new root, options
+          traverser.traverse(value) do |file_node|
+            file_node.create
+          end
+        end
+      end
+    end
+  end
+end   

data/spec/skeleton_creator_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'rake'
+
+describe "SkeletonCreator" do
+  it "should create a directory structure" do
+    file_name = File.expand_path(File.join(Dir.pwd,  '../config-files/apps.yml'))
+    puts "=========="    
+    puts file_name
+    runner = FileSystem::Runner.new file_name
+    root_dir = "~/testing"
+    runner.run root_dir
+    FileUtils.cd root_dir do
+      FileList['**/*'].size.should > 30 
+      FileUtils.rm_rf root_dir
+    end
+  end
+
+  it "should not create a directory structure if set to fake" do
+    file_name = File.expand_path(File.join(Dir.pwd,  '../config-files/apps.yml'))
+    puts "=========="    
+    puts file_name
+    runner = FileSystem::Runner.new file_name
+    root_dir = "~/testing4"
+    runner.run root_dir, :fake => true
+    File.directory?(root_dir).should == false
+  end
+    
+  it "should create multiple of the same directory structures in differet locaions" do
+    file_name = File.expand_path(File.join(Dir.pwd,  '../config-files/apps.yml'))
+    runner = FileSystem::Runner.new file_name
+    root_dirs = ["~/testing", "#{ENV['HOME']}/testing2"]
+    root_dirs.each do |root_dir|    
+      runner.run root_dir
+      FileUtils.cd root_dir
+      FileList['**/*'].size.should > 70 
+      FileUtils.rm_rf root_dir
+    end
+  end 
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'skeleton_creator'
+require 'rspec'
+require 'rspec/autorun'
+
+# Spec::Runner.configure do |config|
+#   
+# end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: skeleton_creator
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: Generate a skeleton file structure from a YAML config file
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/file_system/directory.rb
+- lib/file_system/fake_directory.rb
+- lib/file_system/fake_file.rb
+- lib/file_system/file.rb
+- lib/file_system/traverser.rb
+- lib/skeleton_creator.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/aslakhellesoy/cucumber-rails
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Generate a skeleton file structure from a YAML file
+test_files: 
+- spec/skeleton_creator_spec.rb
+- spec/spec_helper.rb