mise_en_place 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2ee03a9e595096ccc9f73aa0b042afb1cd977d3
+  data.tar.gz: ae15bd5d4d80e483c25677315ed0069f8a2728dc
+SHA512:
+  metadata.gz: 9d1b7636b2f9b40e8876ac49527ee82b793de57077b672965edfdb50a2a470300b7ccadcf62c9b66420c79aef59e21a7da69885f99d51e7994570c838efb00d1
+  data.tar.gz: 50fb138888ae6285a98059078599b3734524ec940f1864b215c36ac1070c586d3e0dcc2ee95a9fbe5f16f5e8bc887b92e59582c0531311d18737dfb8ab955416

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+Gemfile.lock
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'rake'
+gem 'rspec', '~>3.5.0'

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Patrick O'Brien
+
+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,58 @@
+[![Build Status](https://travis-ci.org/pmo3/mise_en_place.svg?branch=master)](https://travis-ci.org/pmo3/mise_en_place)
+
+# MiseEnPlace
+
+MiseEnPlace is a ruby gem made for quick and easy bootstrapping of new projects. By specifying your desired directory structure in YAML files, you can create folders and files for complex projects with one command.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mise_en_place'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mise_en_place
+
+## Usage
+
+Basic usage is `mise_en_place PROJECT_NAME`.
+
+By default Mise looks in the current directory and its parents for a .mise_en_place.yml file, but you can specify the location of a config file with `-c` or `--config`.
+
+A config file should look something like this:
+
+```yaml
+---
+- default:
+  - js:
+    - index.js
+    - subfolder:
+      - something.js
+  - index.html
+  - images
+
+- html:
+  - index.html
+  - contact.html
+```
+The `default` structure is required, and will be used in the absence of the project flag. To use a different structure specify the type with `-p` or `--project`
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pmo3/mise_en_place.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/mise_en_place/mise"
+require_relative "../lib/mise_en_place/parser"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -eu pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/mise_en_place

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+
+require 'mise_en_place/mise'
+require 'mise_en_place/parser'
+
+options = MiseEnPlace::Parser.parse(ARGV)
+creator = MiseEnPlace::Mise.new(options)
+creator.build_file_structure

data/lib/mise_en_place/mise.rb

@@ -0,0 +1,139 @@
+#! /usr/bin/env ruby
+
+require 'fileutils'
+require 'yaml'
+require 'pathname'
+require 'ostruct'
+require 'optparse'
+
+module MiseEnPlace
+  class Mise
+    CONFIG_FILENAME = ".mise_en_place.yml"
+    CONFIG_PATH = Pathname(File.expand_path('~')) + CONFIG_FILENAME
+
+    def initialize(options={})
+      @options = OpenStruct.new options
+      @top_level_dir = Pathname(@options.project_name)
+      request_and_overwrite if File.exist? @top_level_dir
+      FileUtils.mkdir_p(@top_level_dir)
+    end
+
+    def options
+      @options
+    end
+
+    def fetch_yaml(config_path=@options.config)
+      begin
+        full_yaml = YAML.load_file(config_path || find_config)
+        unless full_yaml
+          warn_no_project_type
+          return
+        end
+        project_type = options.project_type || "default"
+        full_yaml = full_yaml.reduce(:merge)[project_type]
+        warn_no_project_type unless full_yaml
+        return full_yaml
+      rescue Errno::ENOENT, TypeError
+        puts "\
+        Please make sure a file named #{CONFIG_FILENAME} exists in your current directory or any of its parent directories or specify a path with the --config option"
+        exit(false)
+      end
+    end
+
+    def build_file_structure(yaml=fetch_yaml, path=@top_level_dir)
+      path = Pathname(path)
+      return unless yaml
+      yaml.each do |file|
+        if file.is_a?(Hash)
+          file.values.each do |sub_file|
+            build_file_structure(sub_file, path + file.keys.first)
+          end
+        else
+          # cast to Array to avoid type checking between Array or String
+          Array[file].each do |sub_file|
+            create_file_or_dir(sub_file, path)
+          end
+        end
+      end
+    end
+
+    private
+
+    def warn_no_project_type
+      puts "\
+      Could not find a valid yaml structure for your project. Make sure that a default structure or one for your project type exists in your config file. Try something like this:
+
+      ---
+      - default:
+        - file_structure_here
+      "
+      puts "\
+      - #{options.project_type}
+        - file_structure_here" if options.project_type
+      exit(false)
+      return
+    end
+
+    def create_file_or_dir(file_or_dir, path)
+      full_path = Pathname(path + file_or_dir)
+      if is_dir?(file_or_dir)
+        FileUtils.mkdir_p(full_path)
+      else
+        FileUtils.mkdir_p(path)
+        FileUtils.touch(full_path)
+      end
+    end
+
+    def is_dir?(file_or_dir)
+      Pathname(file_or_dir).extname == ""
+    end
+
+    def find_config
+      path = Pathname(Dir.pwd)
+      while path != Pathname("/")
+        return path + CONFIG_FILENAME if File.exist? path + CONFIG_FILENAME
+        path = path.parent
+      end
+      return request_and_build_config
+    end
+
+    def request_and_build_config
+      input = ask_to_build_config
+      if input == "" || input == "y"
+
+        File.open(CONFIG_PATH, 'w') do |f|
+          f.puts "---"
+          f.puts "- default:"
+        end unless File.exist? CONFIG_PATH
+        puts "File created at #{CONFIG_PATH}. Add your desired project structure under default and run MiseEnPlace again."
+        return CONFIG_PATH
+      else
+
+        return nil
+      end
+    end
+
+    def ask_to_build_config
+      puts "Could not find a config file. Would you like to create one now? [Y/n]"
+      gets.chomp.downcase
+    end
+
+    def ask_to_overwrite
+      puts "A folder with #{@top_level_dir} already exists. Overwrite? [y/N]"
+      gets.chomp.downcase
+    end
+
+    def request_and_overwrite
+      input = ask_to_overwrite
+      if input == "y"
+        return true
+      else
+        exit(false)
+      end
+    end
+
+    def command_line_args
+      ARGV
+    end
+  end
+end

data/lib/mise_en_place/parser.rb

@@ -0,0 +1,55 @@
+require 'ostruct'
+require 'optparse'
+require 'pathname'
+
+module MiseEnPlace
+  class Parser
+    FLAGS = %w(-c --config -h --help -p --project)
+
+    def self.parse(args)
+      options = OpenStruct.new
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: ProjectCreator [project_title] [options]"
+        opts.separator ""
+        opts.separator "Specific Options:"
+
+        opts.on("-c", "--config PATH", "Path to your config file") do |path|
+          options.config = Pathname(path)
+        end
+
+        opts.on("-h", "--help", "Show this message") do
+          puts ""
+          puts opts
+          exit
+        end
+
+        opts.on("-p", "--project TYPE", "Specify a project type that matches a type in your config file") do |type|
+          options.project_type = type
+        end
+
+        opts.on_tail("-v", "--version", "Show Version number") do
+          puts VERSION
+          exit
+        end
+
+      end
+      opt_parser.parse!(args)
+      project_name = args.shift
+      unless valid_project_name? project_name
+        puts "Please specify a project name"
+        exit(false)
+      end
+      options.project_name = project_name
+      options
+    end
+
+    private
+
+    def self.valid_project_name?(project_name)
+      is_flag = FLAGS.include? project_name
+      does_not_exist = (project_name == nil)
+      return !(is_flag || does_not_exist)
+    end
+  end
+end

data/lib/mise_en_place/version.rb

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

data/mise_en_place.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mise_en_place/version"
+
+Gem::Specification.new do |spec|
+ spec.name        = "mise_en_place"
+ spec.version     = MiseEnPlace::VERSION
+ spec.platform    = Gem::Platform::RUBY
+ spec.authors     = ["Patrick O'Brien"]
+ spec.email       = ["patrick@patrickmobrien.com"]
+ spec.homepage    = "http://rubygems.org/gems/mise_en_place"
+ spec.summary     = %q{A gem to quickly bootstrap new projects by specifying directory structure in yaml files}
+ spec.description = %q{MiseEnPlace is a ruby gem made for quick and easy bootstrapping of new projects. By specifying your desired directory structure in YAML files, you can create folders and files for complex projects with one command.}
+ spec.license       = "MIT"
+
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
+ if spec.respond_to?(:metadata)
+   spec.metadata['allowed_push_host'] = "https://rubygems.org"
+ else
+   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+ end
+
+ spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+ spec.bindir        = "exe"
+ spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+ spec.require_paths = ["lib"]
+
+ spec.add_development_dependency "bundler", "~> 1.12"
+ spec.add_development_dependency "rake", "~> 10.0"
+ spec.add_development_dependency "rspec", "~> 3.0"
+end

data/sample_config.yml

@@ -0,0 +1,12 @@
+---
+- default:
+  - js:
+    - index.js
+    - subfolder:
+      - something.js
+  - index.html
+  - images
+
+- html:
+  - index.html
+  - contact.html

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: mise_en_place
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patrick O'Brien
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: MiseEnPlace is a ruby gem made for quick and easy bootstrapping of new
+  projects. By specifying your desired directory structure in YAML files, you can
+  create folders and files for complex projects with one command.
+email:
+- patrick@patrickmobrien.com
+executables:
+- mise_en_place
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/mise_en_place
+- lib/mise_en_place/mise.rb
+- lib/mise_en_place/parser.rb
+- lib/mise_en_place/version.rb
+- mise_en_place.gemspec
+- sample_config.yml
+homepage: http://rubygems.org/gems/mise_en_place
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A gem to quickly bootstrap new projects by specifying directory structure
+  in yaml files
+test_files: []