new 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c3b29c54510394a8dfc16cc00b715664c80ebae
-  data.tar.gz: b10f62854a0d4ae54c26828fe0478df3d788f9e9
+  metadata.gz: 6bc7ceccb527c6c45b6d98046b396a55890aa2bc
+  data.tar.gz: 688b33a0980e1ab5413d2e2d92fbc1b187d93c72
 SHA512:
-  metadata.gz: dd87c91c29b0e0ea974c1492f1403d9945f5ca931ddd68d4bdeea0f3cba87cce14814bfd6a615ccec05041b5c934276c34a432d494ee4cde578bae833ae2cd78
-  data.tar.gz: 0417f699e034770fd7376e83d244ad86e264765b239f278ae416fe96b82516a56048ea3493f0f07076795a6412f808488de5022e09e997497d9fa58d8f099af0
+  metadata.gz: 3896cfd37150e57dba854c0da96a35880e537434a2e9b5348e43884acc7b8445c22f8b27ebff21b887a711f8797b5d143b135b9c0388e3f5c072b0f12cc24fed
+  data.tar.gz: 3ad4cb4fbf8b15e15316a7d12bd74f9af061f9583164ef142f95c5f21a6b5c218ca55aaf83f809767f0923f78f2f35dffc1f16c29a28b9fe29e5ddad689f7e4c

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.bundle
+.tmp
+.new
+pkg
+tmp
+*.gem

data/.rspec

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

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'activesupport'
+gem 'colorize'
+gem 'rake'
+gem 'recursive-open-struct'
+gem 'semantic'
+gem 'thor'
+
+group :development do
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'rspec'
+  gem 'terminal-notifier-guard'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    colorize (0.6.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.3.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-bundler (2.0.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+    guard-rspec (4.2.5)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    i18n (0.6.9)
+    listen (2.4.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    recursive-open-struct (0.4.5)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    semantic (1.3.0)
+    slop (3.4.7)
+    terminal-notifier-guard (1.5.3)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    timers (1.1.0)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  colorize
+  guard
+  guard-bundler
+  guard-rspec
+  rake
+  recursive-open-struct
+  rspec
+  semantic
+  terminal-notifier-guard
+  thor

data/Guardfile

@@ -0,0 +1,14 @@
+# More info at https://github.com/guard/guard#readme
+
+notification :terminal_notifier, subtitle: 'ruby.gems.new'
+
+guard :bundler do
+  watch('Gemfile')
+end
+
+guard :rspec, all_after_pass: true, all_on_start: true, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+  watch('.rspec')               { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Brewster
+
+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,121 @@
+# new
+###### install
+```shell
+gem install new
+new init
+```
+
+###### Create a new project
+```shell
+new [TEMPLATE] [NAME]
+```
+
+###### Release a new version
+```shell
+new release
+```
+
+#### Templates
+Templates represent a boilerplate directory & file structure preconfigured for a given project type. _(eg js, ruby, gem, rails, etc.)_
+
+#### Tasks
+Tasks represent a process associated with releasing new code.  Tasks are run in order they are listed in the project `.new` configuration file. _(eg github, gem, etc.)_
+
+#### Local Config/Templates/Tasks
+After running `new init`, you will have `.new` folder in your home directory.  This directory contains:
+
+* `.new` local configuration file
+* `tasks` directory for custom tasks
+* `templates` directory for custom templates
+
+Copy or create custom templates & tasks in these folders.  They will take precendence over the default templates included with the gem.
+
+**Make sure to edit your local configuration file!**
+
+```yaml
+# ~/.new/.new
+
+license: MIT
+developer:
+  name: Foo Bar
+  email: foo@bar.com
+templates:
+  foo_template:
+    custom: option
+tasks:
+  github:
+    username: foouser
+```
+
+
+#### Custom Templates
+* The directory name will be used for the template name.
+* Templates can have a `.new` file in the root of the folder.  These values can be accessed through interpolation.
+
+```yaml
+# ~/.new/templates/foo_template/.new
+
+foo: bar
+tasks:
+  foo_task:
+  bar_task:
+    baz: 'baz'
+```
+
+_Note: the tasks are followed by a colon `:` whether they have options or not._
+
+###### Interpolation
+Use ERB template syntax in your files to interpolate template options.  Make sure to add `.erb` to the end of the filename.
+
+You can also access any custom values set in your local configuration file.
+
+```erb
+<%# ~/.new/templates/foo_template/foo.txt.erb %>
+
+<%= license %>
+<%= developer.name %>
+<%= developer.email %>
+<%= type %>
+<%= project_name %>
+<%= foo %>
+<%= tasks.bar_task.baz %>
+```
+
+You can also interpolate directory and filenames using the syntax `foo_[DEVELOPER.NAME].txt`
+
+_Note using the dot notation to access nested attributes._
+
+#### Custom Tasks
+* The directory name will be used for the task name
+* A `.rb` file must be included in the directory with the same name
+* The `.rb` file must contain a class of `New::Task::FooTask` and inherit from `New::Task`
+* The `.rb` file must have a standard ruby `run` method that will run when a project is released.
+* A Task can have an `OPTIONS` constant with default options needed for the task to run.  These can be further customized in the project or local configuration `.new` file
+
+```ruby
+# ~/.new/tasks/foo_task/foo_task.rb
+
+class New::Task::FooTask < New::Test
+  OPTION = {
+    foo: 'bar'
+  }
+
+  def run
+    # do stuff here
+    # access task options from the `options` object
+    # access all project options from the `project_options` object
+  end
+end
+```
+
+#### TODO
+* optional scripts when creating a template
+* write templates
+* write tasks
+
+#### Contributing
+1. Fork it ( http://github.com/brewster1134/new/fork )
+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/bin/new

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'new'
+
+New::Cli.start ARGV

data/lib/new/cli.rb

@@ -0,0 +1,94 @@
+require 'thor'
+require 'yaml'
+
+class New::Cli < Thor
+  desc '[TEMPLATE] [NAME]', "Create a new project with a given template (#{New.templates.join(' ')})"
+  # option :name, required: true
+  def method_missing method, *args
+    if New.templates.include? method.to_sym
+      # Split args that look like options (i.e start with - or --) into a separate array
+      positional_args, opts = Thor::Options.split args
+
+      # extract name from args
+      name = positional_args[0]
+      raise Thor::RequiredArgumentMissingError unless name
+
+      # Add all options here
+      # Make sure to include required options up above as well so they show in the help menu
+      parser = Thor::Options.new(
+      #   name: Thor::Option.new(:name, required: true, type: :string)
+      )
+
+      # The options hash is frozen in #initialize so you need to merge and re-assign
+      self.options = options.merge(parser.parse(opts)).freeze
+
+      # Dispatch the command
+      project method, name
+    else
+      super
+    end
+  end
+
+  desc 'init', 'Set up your home directory folder for storing custom templates and default configuration'
+  def init
+    if Dir.exists? New::CUSTOM_DIR
+      New.say 'Home folder already exists.', type: :warn
+    else
+      # create folder
+      New.say 'Creating home folder.', type: :success
+      FileUtils.mkdir_p New::CUSTOM_DIR
+      FileUtils.mkdir_p File.join(New::CUSTOM_DIR, New::TASKS_DIR_NAME)
+      FileUtils.mkdir_p File.join(New::CUSTOM_DIR, New::TEMPLATES_DIR_NAME)
+
+      # create config file
+      New.say 'Creating default configuration file.', type: :success
+      File.open File.join(New::CUSTOM_DIR, New::CONFIG_FILE), 'w' do |f|
+        f.write New::Template::CUSTOM_CONFIG_TEMPLATE.to_yaml
+      end
+
+      New.say "Edit #{File.join(New::CUSTOM_DIR, New::CONFIG_FILE)} with your custom configuration details.", type: :warn
+    end
+  end
+
+  desc 'release', 'Release your new code (Run from within a project directory!)'
+  def release
+    project_config_file = File.join(Dir.pwd,  New::CONFIG_FILE)
+    raise unless File.exists? project_config_file
+
+    # get project config file
+    project_config = YAML.load(File.open(project_config_file)).deep_symbolize_keys!
+
+    # extract tasks from configuration
+    tasks = (project_config[:tasks] || {}).keys.map(&:to_sym)
+
+    tasks.each do |task|
+      # require custom task and initialize it
+      begin
+        if New.custom_tasks.include? task
+          require "#{New::CUSTOM_DIR}/#{New::TASKS_DIR_NAME}/#{task}/#{task}"
+        else
+          require "#{New::DEFAULT_DIR}/#{New::TASKS_DIR_NAME}/#{task}/#{task}"
+        end
+      rescue LoadError
+        New.say "No task '#{task}' found!", type: :fail
+        next
+      end
+      "New::Task::#{task.to_s.classify}".constantize.new project_config
+    end
+  end
+
+private
+
+  def project template, name
+    if Dir.exists? File.join(Dir.pwd, name)
+      New.say "A project named #{name} already exists...", type: :warn
+      New.say "                       Overwrite it? [Yn]", type: :warn
+      exit if STDIN.gets.chomp! != 'Y'
+
+      # Delete existing project
+      FileUtils.rm_rf File.join(Dir.pwd, name)
+    end
+
+    New::Project.new template, name
+  end
+end

data/lib/new/core.rb

@@ -0,0 +1,6 @@
+require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/deep_dup'
+require 'active_support/core_ext/string/inflections'
+require 'colorize'
+require 'date'

data/lib/new/dsl.rb

@@ -0,0 +1,42 @@
+module New::Dsl
+  # Replacement for `puts` that accepts various stylistic arguments
+  # https://github.com/fazibear/colorize/blob/master/lib/colorize.rb
+  #
+  # justify:  => [center|ljust|rjust] The type of justification to use
+  # padding:  => [integer] The maximum string size to justify text in
+  # color:    => [integer] See link above for supported colors
+  # bgcolor:  => [integer] See link above for supported colors
+  # type:     => [symbol] Preset colors for [:fail, :success, :warn]
+  #
+  def say text = '', args = {}
+    # Justify options
+    if args[:justify] && args[:padding]
+      text = text.send args[:justify], args[:padding]
+    end
+
+    # Color text
+    text = text.colorize(color: args[:color]) if args[:color]
+
+    # Color background
+    text = text.colorize(background: args[:bgcolor]) if args[:bgcolor]
+
+    # Type options
+    # process last due to the addition of special color codes
+    text = case args[:type]
+    when :fail
+      text.red
+    when :success
+      text.green
+    when :warn
+      text.yellow
+    else
+      text
+    end
+
+    if args[:indent]
+      text = (' ' * args[:indent]) + text
+    end
+
+    puts text
+  end
+end

data/lib/new/interpolate.rb

@@ -0,0 +1,100 @@
+require 'erb'
+require 'recursive-open-struct'
+
+module New::Interpolate
+  # regex to match capital underscored template options names ie [PROJECT_NAME]
+  FILENAME_RENAME_MATCH = /\[([A-Z_.]+)\]/
+
+  # Convienance method for processing everything
+  #
+  def interpolate src_path, options
+    @src_path = src_path
+    @options = options
+
+    copy_to_tmp
+    process_paths
+    process_files
+  end
+
+  def dir; @dest_path; end
+
+  # Convert options to OpenStruct so we can use dot notation in the templates
+  #
+  def dot_options
+    @dot_options ||= RecursiveOpenStruct.new(@options)
+  end
+
+private
+
+  # Allow templates to call option values directly
+  #
+  def method_missing method
+    dot_options.send(method.to_sym) || super
+  end
+
+  def copy_to_tmp
+    # Create a unique temporary path to store the processed files
+    @dest_path = File.join(New::TEMP_DIR, Time.now.to_i.to_s)
+
+    # Create a directory if an individual file is being processed
+    FileUtils.mkdir_p @dest_path if File.file? @src_path
+
+    # Copy to tmp
+    FileUtils.cp_r @src_path, @dest_path
+  end
+
+  # Collect files with a matching value to interpolate
+  #
+  def process_paths
+    get_path = -> type do
+      Dir.glob(File.join(@dest_path, '**/*')).select do |e|
+        File.send("#{type}?".to_sym, e) && e =~ FILENAME_RENAME_MATCH
+      end
+    end
+
+    # rename directories first
+    get_path[:directory].each{ |dir| process_path dir }
+    get_path[:file].each{ |file| process_path file }
+  end
+
+  # Interpolate filenames with template options
+  #
+  def process_path path
+    new_path = path.gsub FILENAME_RENAME_MATCH do
+      # Extract interpolated values into symbols
+      methods = $1.downcase.split('.').map(&:to_sym)
+
+      # Call each method on options
+      methods.inject(dot_options){ |options, method| options.send(method.to_sym) }
+    end
+
+    if File.file? path
+      File.rename path, new_path
+    else
+      FileUtils.mv path, new_path
+    end
+  end
+
+  # Collect files with an .erb extension to interpolate
+  #
+  def process_files
+    Dir.glob(File.join(@dest_path, '**/*.erb'), File::FNM_DOTMATCH).each do |file|
+      process_file file
+    end
+  end
+
+  # Interpolate erb template data
+  #
+  def process_file file
+    # Process the erb file
+    processed_file = ERB.new(File.read(file)).result(binding)
+
+    # Overwrite the original file with the processed file
+    File.open file, 'w' do |f|
+      f.write processed_file
+    end
+
+    # Remove the .erb from the file name
+    File.rename file, file.chomp('.erb')
+  end
+end

data/lib/new/project.rb

@@ -0,0 +1,34 @@
+class New::Project
+  include New::Version
+
+  # Create all variables and run new project creation methods
+  #
+  def initialize template, name
+    @project_dir = File.join(Dir.pwd, name.to_s) # the newly created project directory
+    @template = New::Template.new template, name
+
+    copy_template
+    create_config_file
+  end
+
+private
+
+  # Create the new project by copying the template directory
+  #
+  def copy_template
+    FileUtils.cp_r @template.dir, @project_dir
+
+    # cleanup tmp
+    FileUtils.rm_rf @template.dir
+  end
+
+  # Create the .new configuration file in the new project
+  #
+  def create_config_file
+    new_config = File.join(@project_dir, New::CONFIG_FILE)
+    File.open new_config, 'w' do |f|
+      yaml_options = @template.options.deep_dup.deep_stringify_keys!.to_yaml
+      f.write(yaml_options)
+    end
+  end
+end

data/lib/new/task.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+
+class New::Task
+  def self.inherited task_class
+    task_class.name = caller.first[/[a-z_]+?(?=\.rb)/].to_sym
+  end
+
+  def initialize project_config
+    @project_config = project_config
+    run
+  end
+
+  def self.name= name
+    @name = name
+  end
+  def self.name; @name; end
+  def name; self.class.name.to_sym; end
+
+  # Return ALL available options
+  #
+  def project_options
+    custom_options = New.custom_config
+    project_options = @project_config
+
+    all_options = custom_options.deep_merge(project_options)
+
+    # Groom tasks (prevent tasks from the custom config from polluting the project config)
+    all_options[:tasks].each_key do |task|
+      all_options[:tasks].delete(task) unless project_options[:tasks].has_key?(task)
+    end
+
+    @project_options ||= all_options
+  end
+
+  # Return only the options for the given task
+  #
+  def options
+    default_options = self.class::OPTIONS rescue {}
+    @options ||= default_options.deep_merge(project_options[:tasks][name])
+  end
+end

data/lib/new/template.rb

@@ -0,0 +1,64 @@
+require 'yaml'
+
+class New::Template
+  include New::Interpolate
+
+  # The foundation for new template configuration files
+  #
+  CUSTOM_CONFIG_TEMPLATE = {
+    license: '[LICENSE]',
+    version: '[VERSION]',
+    developer: {
+      name: '[NAME]',
+      email: '[EMAIL]'
+    }
+  }
+
+  def initialize type, name
+    @type = type
+    @name = name
+
+    interpolate template_dir, options
+  end
+
+  # Create the options object
+  #
+  def options
+    # merge options together
+    CUSTOM_CONFIG_TEMPLATE.clone
+      .deep_merge!(template_config)
+      .deep_merge!(New.custom_config)
+      .deep_merge!({
+        project_name: @name,
+        type: @type.to_s
+      })
+  end
+
+private
+
+  # Get the template directory to copy from
+  #
+  def template_dir
+    @template_dir ||= if New.custom_templates.include? @type
+      @custom = true
+      File.join(New::CUSTOM_DIR, New::TEMPLATES_DIR_NAME, @type.to_s)
+    else
+      File.join(New::DEFAULT_DIR, New::TEMPLATES_DIR_NAME, @type.to_s)
+    end
+  end
+
+  # Get the configuration for the template
+  #
+  def template_config
+    return @template_config if @template_config
+
+    @template_config = YAML.load(File.open(File.join(template_dir, New::CONFIG_FILE))).deep_symbolize_keys! rescue {}
+    if @custom
+      @template_config.merge!({
+        custom: true
+      })
+    end
+
+    @template_config
+  end
+end