framer 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/ruby

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Hare
+
+MIT License
+
+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,53 @@
+# Framer
+
+Framer creates directory structures from YAML files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "framer"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install framer
+
+## Usage
+
+Framer is designed to take a YAML file and turn it into a directory structure on disk. 
+
+First you need to have a YAML file that describes your directory structure:
+
+    # framer.yml
+    ---
+    :root1:
+      :root1_dir1:
+        :root1_dir1_sub1: {}
+      :root1_dir2: {}
+    :root2:
+      :root2_dir1: {}
+      :root2_dir2:
+        :root2_dir2_sub1: {}
+        :root2_dir2_sub2: {}
+
+Then you can use either the API to generate the structure:
+
+    Framer.frame "path_to_yaml_file", "path_to_output_dir"
+
+Or you can generate the same structure from the comand line:
+
+    $ framer frame "path_to_yaml_file", "path_to_output_dir"
+
+*NOTE:* You can execute `$ framer frame` without any arguments and Framer will look for a "framer.yml" in the current directory and build the output in the current directory by default.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+task default: :spec

data/bin/framer

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "framer/cli"
+
+Framer::CLI.start

data/framer.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "framer/version"
+
+Gem::Specification.new do |s|
+  s.name          = "framer"
+  s.version       = Framer::VERSION
+  s.authors       = "Andrew Hare"
+  s.email         = ""
+  s.description   = "A simple gem for creating directory structures from YAML files."
+  s.summary       = "A simple gem for creating directory structures from YAML files."
+  s.homepage      = ""
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = "spec"
+  s.require_paths = ["lib"]
+  s.executables   = "framer" 
+
+  s.add_dependency "thor"
+
+  s.add_development_dependency "rspec"
+end

data/lib/framer.rb

@@ -0,0 +1,13 @@
+require "framer/version"
+require "framer/parser"
+require "framer/builder"
+
+module Framer
+
+  def self.frame(yaml_path, build_path)
+    parser = Parser.new yaml_path
+    builder = Builder.new(build_path, parser.tree)
+    builder.build
+  end
+
+end

data/lib/framer/builder.rb

@@ -0,0 +1,23 @@
+require "fileutils"
+
+module Framer
+  class Builder
+    attr_reader :dirs
+
+    def initialize(path, tree)
+      @dirs = get_dirs(path, tree)
+    end
+
+    def build
+      FileUtils.mkdir_p @dirs
+    end
+
+    def get_dirs(root, tree)
+      tree.map do |key, value|
+        new_root = File.join(root, key.to_s)
+        [new_root, get_dirs(new_root, value)]
+      end.flatten
+    end
+  end
+
+end

data/lib/framer/cli.rb

@@ -0,0 +1,15 @@
+require "thor"
+require "framer"
+
+module Framer
+  class CLI < Thor
+
+    desc "frame YAML_PATH, BUILD_PATH", "Build the frame."
+    method_option :yaml_path, default: "framer.yml"
+    method_option :build_path, default: "./"
+    def frame(yaml_path, build_path)
+      Framer.frame yaml_path, build_path
+    end
+
+  end
+end

data/lib/framer/parser.rb

@@ -0,0 +1,12 @@
+require "yaml"
+
+module Framer
+  class Parser
+    attr_reader :tree
+
+    def initialize(path)
+      @tree = YAML.load_file path
+    end
+
+  end
+end

data/lib/framer/version.rb

@@ -0,0 +1,3 @@
+module Framer
+  VERSION = "0.0.1"
+end

data/spec/framer/builder_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+require "fileutils"
+
+describe Framer::Builder do
+
+  def directory_hash(main_path)
+    all = Dir.glob(main_path + '/**/*')
+    dirs = all.select {|f| File.directory?(f) }
+    parts = dirs.map {|path| path.sub(main_path+ "/", "").split("/") }
+    parts.reduce({}) {|acc, path_parts|
+      path_parts.reduce(acc) do |acc2, dir|
+        acc2[dir.to_sym] ||= {}
+      end
+      acc
+    }
+  end
+
+  describe "#build" do
+    it "should build the tree" do
+      builder = Framer::Builder.new(@build_path, @tree)
+      builder.build
+      directory_hash(@build_path).should eq @tree
+    end
+  end
+
+end

data/spec/framer/parser_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+require "yaml"
+require "fileutils"
+
+describe Framer::Parser do
+
+  describe "#load" do
+    it "should load the settings file" do
+      parser = Framer::Parser.new @yaml_path
+      parser.tree.should eq @tree
+    end
+  end
+
+end

data/spec/framer_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+require "fileutils"
+
+describe Framer do
+
+  describe "#frame" do
+    it "should frame everything" do
+      Framer.frame(@yaml_path, @build_path)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require "rubygems"
+require "framer"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+
+  config.before :each do
+    @build_path = "tmp/build"
+    @yaml_path = "tmp/framer_example.yml"
+    @tree = { 
+      root1: { 
+        root1_dir1: {
+          root1_dir1_sub1: {}
+        }, 
+        root1_dir2: {} 
+      }, 
+      root2: { 
+        root2_dir1: {}, 
+        root2_dir2: { 
+          root2_dir2_sub1: {},
+          root2_dir2_sub2: {}
+        } 
+      } 
+    }
+    FileUtils.remove_dir "tmp", true
+    FileUtils.mkdir_p @build_path
+    IO.write(@yaml_path, YAML.dump(@tree))
+  end
+end

data/spec/support/framer_example.yml

@@ -0,0 +1,10 @@
+---
+:root1:
+  :root1_dir1:
+    :root1_dir1_sub1: {}
+  :root1_dir2: {}
+:root2:
+  :root2_dir1: {}
+  :root2_dir2:
+    :root2_dir2_sub1: {}
+    :root2_dir2_sub2: {}

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: framer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Hare
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: A simple gem for creating directory structures from YAML files.
+email: ''
+executables:
+- framer
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/framer
+- framer.gemspec
+- lib/framer.rb
+- lib/framer/builder.rb
+- lib/framer/cli.rb
+- lib/framer/parser.rb
+- lib/framer/version.rb
+- spec/framer/builder_spec.rb
+- spec/framer/parser_spec.rb
+- spec/framer_spec.rb
+- spec/spec_helper.rb
+- spec/support/framer_example.yml
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple gem for creating directory structures from YAML files.
+test_files: []