yamlir 0.1.0

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yamlir.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Evgeniy Fateev
+
+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,106 @@
+# YAMLir
+
+YAMLir - is a simple library for generating folders structure in [YAML](http://www.yaml.org/) format. For example:
+
+    books
+    ├── architecture
+    │   └── event-driven
+    │       ├── event_driven_programming.pdf
+    │       ├── eventmachine_introduction_10.pdf
+    │       └── eventmachine_presentation.pdf
+    ├── rails
+    │   └── Rails.3.in.Action.pdf
+    └── ruby
+        ├── Design Patterns in Ruby.pdf
+        └── RubyMethodLookupFlow.pdf
+
+And the same structure with YAMLir:
+
+    ---
+    books:
+      architecture:
+        event-driven:
+          event_driven_programming.pdf: 
+          eventmachine_introduction_10.pdf: 
+          eventmachine_presentation.pdf: 
+      rails:
+        Rails.3.in.Action.pdf: 
+      ruby:
+        Design Patterns in Ruby.pdf: 
+        RubyMethodLookupFlow.pdf: 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yamlir'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yamlir
+
+## Usage
+
+    YAMLir.generate
+
+This code will create *yamlir.yml* file in the current directory with the recursive structure of it.
+
+## Options
+
+It's possible to change some things.
+
+To change *<a href="http://en.wikipedia.org/wiki/Glob_(programming)">glob</a>* pattern:
+
+    YAMLir.generate glob: "{app/{models},lib}/**/*"
+
+For custom *output file* name (default is yamlir.yml):
+
+    YAMLir.generate file: "result.yml"
+
+For change *output directory* path (missing directories will be created):
+
+    YAMLir.generate path: "/tmp/structure"
+
+## Custom modes
+
+### Foreword
+
+YAMLir can be augmented by custom modes.
+
+Originally this gem was conceived like a tool for generating a list of rails application files for subsequent marks those of them that have been tested and start the corresponding test suites. That's why YAMLir includes *RailsTestCover* mode which generates rails *app* directory structure and puts the result file (named *cover.yml*) in the *test* or *spec* folder. Later this idea was realized in a more general form with the possibility of adding custom modes.
+
+### Create own mode
+
+Suppose we want to create mode that generates all mp3 files under Music directory. This is it:
+
+    # lib/yamlir/mode/mp3.rb
+
+    module YAMLir
+
+      class Mp3 < Base
+
+        @glob = "/home/psylone/Music/**/*.{mp3}"
+        @file = "mp3.yml"
+        @path = "."
+
+      end
+
+    end
+
+To generate YAML structure write:
+
+    YAMLir::Mp3.generate
+
+All this work can also be done using options with *YAMLir.generate* method.
+
+## 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/yamlir

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'yamlir'

data/lib/yamlir.rb

@@ -0,0 +1,18 @@
+require "yamlir/sorted_list"
+require "yamlir/tree"
+require "yamlir/mode"
+require "yamlir/version"
+
+module YAMLir
+
+  def self.generate options = {}
+    Simple.generate options
+  end
+
+  # def self.register! options
+    # TODO register new mode
+    #
+    # YAMLir.register! name: "Sinatra", glob: "", file: "", path: ""
+  # end
+
+end

data/lib/yamlir/mode.rb

@@ -0,0 +1,58 @@
+require "set"
+require "yaml"
+require "fileutils"
+
+module YAMLir
+
+  class Base
+
+    module ClassMethods
+
+      def generate options = {}
+        # TODO: Add options:
+        #   recursive: "true or false recursive"
+        #   folder_only: "get folders only"
+        #   without_extensions: "true of false for extensions" There'll be problem for the folder with the same name as the file without extension
+        #   store: true or false - store or not result in file
+        @glob = normalize options[:glob] || @glob
+        @file = normalize options[:file] || @file
+        @path = normalize options[:path] || @path
+        store process Dir[*@glob]
+      end
+
+
+      private
+
+      def store result
+        @path.chomp! "/"
+        FileUtils.mkdir_p @path
+        name = [@path, @file].join "/"
+        File.open(name, "w"){ |f| f.write result }
+      end
+
+      def process list
+        tree(seed list).to_yaml
+      end
+
+      def tree source
+        Tree.new(source).growth
+      end
+
+      def seed list
+        list = YAMLir::SortedList.sort(list)
+        Set.new(list).classify{ |name| File.dirname(name) }
+      end
+
+      def normalize opt
+        opt.is_a?(Proc) ? opt.call : opt
+      end
+
+    end
+
+    extend ClassMethods
+
+  end
+
+end
+
+Dir[File.expand_path("../mode", __FILE__).concat "/*.{rb}"].each{ |mode| require mode }

data/lib/yamlir/mode/rails_test_cover.rb

@@ -0,0 +1,13 @@
+module YAMLir
+
+  class RailsTestCover < Base
+
+    @glob = "app/{controllers,helpers,mailers,models}/**/*"
+    @file = "cover.yml"
+    @path = Proc.new do
+      Dir.exist?("spec") ? "spec" : "test"
+    end
+
+  end
+
+end

data/lib/yamlir/mode/simple.rb

@@ -0,0 +1,11 @@
+module YAMLir
+
+  class Simple < Base
+
+    @glob = "**/*"
+    @file = "yamlir.yml"
+    @path = "."
+
+  end
+
+end

data/lib/yamlir/sorted_list.rb

@@ -0,0 +1,28 @@
+module YAMLir
+
+  module SortedList
+
+    module ClassMethods
+
+      def sort list
+        list.sort do |a, b|
+          if slashes(a) == slashes(b)
+            a <=> b
+          else
+            slashes(a) <=> slashes(b)
+          end
+        end
+      end
+
+      def slashes str
+        str.split("").select{ |char| char == "/" }.count
+      end
+      private :slashes
+
+    end
+
+    extend ClassMethods
+
+  end
+
+end

data/lib/yamlir/tree.rb

@@ -0,0 +1,44 @@
+module YAMLir
+
+  class Tree
+
+    def initialize source
+      @source = source
+      @purpose = {}
+    end
+
+    def growth
+      for node, values in @source do create(node, values) end
+      @purpose
+    end
+
+
+    private
+
+    def create node, values
+      node = node.split "/"
+      traverse node, values
+    end
+
+    def traverse node, values
+      current_branch = @purpose
+      while node.length > 1
+        key = node.shift
+        current_branch.update key => {} unless current_branch[key]
+        current_branch = current_branch[key]
+      end
+      add current_branch, node.shift, values
+    end
+
+    def add branch, node, values
+      if node == "."
+        values.each{ |leaf| branch.update File.basename(leaf) => nil unless branch[leaf] || @source.keys.include?(leaf) }
+      else
+        branch[node] = {} unless branch[node]
+        values.each{ |leaf| branch[node].update File.basename(leaf) => nil unless @source.keys.include?(leaf) }
+      end
+    end
+
+  end
+
+end

data/lib/yamlir/version.rb

@@ -0,0 +1,3 @@
+module YAMLir
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'yamlir'

data/spec/yamlir_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe YAMLir do
+  it 'should have a version number' do
+    YAMLir::VERSION.should_not be_nil
+  end
+
+  it 'should do something useful' do
+    false.should be_true
+  end
+end

data/yamlir.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yamlir/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yamlir"
+  spec.version       = YAMLir::VERSION
+  spec.authors       = ["Evgeniy Fateev"]
+  spec.email         = ["spaceflow@gmail.com"]
+  spec.description   = %q{Create YAML file (commonly named yamlir.yml) with folders content.}
+  spec.summary       = %q{Generate folder structure in YAML format.}
+  spec.homepage      = "https://github.com/psylone/yamlir"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: yamlir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Evgeniy Fateev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: Create YAML file (commonly named yamlir.yml) with folders content.
+email:
+- spaceflow@gmail.com
+executables:
+- yamlir
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/yamlir
+- lib/yamlir.rb
+- lib/yamlir/mode.rb
+- lib/yamlir/mode/rails_test_cover.rb
+- lib/yamlir/mode/simple.rb
+- lib/yamlir/sorted_list.rb
+- lib/yamlir/tree.rb
+- lib/yamlir/version.rb
+- spec/spec_helper.rb
+- spec/yamlir_spec.rb
+- yamlir.gemspec
+homepage: https://github.com/psylone/yamlir
+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: -4079057136267556810
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4079057136267556810
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Generate folder structure in YAML format.
+test_files:
+- spec/spec_helper.rb
+- spec/yamlir_spec.rb