new 0.1.1 → 1.0.9

data/lib/new/source.rb

@@ -0,0 +1,110 @@
+require 'sourcerer'
+
+class New::Source
+  #
+  # CLASS METHODS
+  #
+  class << self
+    @@sources = {}
+    def sources; @@sources; end
+
+    # loop through sources saved to the global new object and initializes sources from them
+    #
+    def load_sources
+      New.new_object[:sources].each do |name, path|
+        @@sources[name] = New::Source.new name, path
+      end
+    end
+
+    # look through all sources to find a matching task
+    # @param task_name [String/Symbol] valid task name
+    # @param source_name [String/Symbol] valid source name
+    #
+    # @return [String] valid task path
+    #
+    def find_task task_name, source_name = nil
+      # if source is specified, target it directly
+      if source_name
+        return lookup_task source_name, task_name
+
+      # if source and task is specified in a single string
+      elsif task_name.to_s.include? '#'
+        source_task = task_name.split('#').reverse
+        source_name = source_task[1].to_sym
+        task_name = source_task[0].to_sym
+
+        return lookup_task source_name, task_name
+
+      # otherwise loop through sources until a template is found
+      else
+        @@sources.values.each do |source|
+          return source.tasks[task_name.to_sym] || next
+        end
+        S.ay "No `#{task_name}` task was found in any of the sources", :error
+      end
+
+      return nil
+    end
+
+  private
+
+    # use the source and task names to get a task instance
+    # @param source_name [Symbol] symbolized valid source name
+    # @param task_name [Symbol] symbolized valid task name
+    #
+    # @return [New::Task|nil] returns a task, or nil if none is found
+    #
+    def lookup_task source_name, task_name
+      if source = @@sources[source_name.to_sym]
+        if task = source.tasks[task_name.to_sym]
+          return task
+        else
+          S.ay "No `#{task_name}` task was found in the `#{source_name}` source", :error
+        end
+      else
+        S.ay "No `#{source_name}` source was found", :error
+      end
+
+      return nil
+    end
+  end
+
+
+  #
+  # INSTANCE METHODS
+  #
+  attr_reader :name, :path, :tasks
+
+private
+
+  def initialize name, path
+    @name = name
+    @tasks = {}
+
+    # fetch source and create tasks
+    source = Sourcerer.new path
+    source.files('**/*_task.rb').each do |task_file_path|
+      # load task ruby file
+      load task_file_path
+
+      # get task name from task path
+      task_name = New::Task.get_task_name task_file_path
+
+      # lookup task from initialized global tasks
+      task = New::Task.tasks[task_name]
+
+      # unload class so it can be inherited again
+      # this means once a class is loaded, it is inherited, initialized, then destroyed
+      New.send :remove_const, task.class.to_s.sub('New::', '').to_sym
+
+      # add source to task
+      task.source = self
+
+      # add global task to the source tasks object
+      @tasks[task_name] = task
+    end
+
+    # set path to sourcerer path
+    @path = source.source
+  end
+end

data/lib/new/task.rb

@@ -1,39 +1,82 @@
-require 'yaml'
-
 class New::Task
-  def self.inherited task_class
-    task_class.name = caller.first[/[a-z_]+?(?=\.rb)/].to_sym
+  extend New::Validation
+
+  #
+  # CLASS METHODS
+  #
+  class << self
+    # global tasks for task class with a getter
+    @@tasks = {}
+    def tasks; @@tasks; end
+
+    # derive a task name from a task path
+    # @param task_path [String] full path to a task ruby file
+    #
+    def get_task_name task_path
+      task_path.match(/([^\/]*)_task\.rb$/)[1].to_sym
+    end
+
+  private
+
+    # when custom task is required, add the class to the global hash to initialize later
+    #
+    def inherited subclass
+      # get task details from path
+      path = caller.first.match(/(^.*_task\.rb).*$/)[1]
+      name = get_task_name path
+
+      # add subclass to global object for easier lookup
+      @@tasks[name] = subclass.new name, path
+    end
   end
 
-  def initialize project_config
-    @project_config = project_config
-    run
+
+  #
+  # INSTANCE METHODS
+  #
+  attr_accessor :source, :options
+  attr_reader :name, :path
+
+  # getters/setters for task meta data stored temporarily on a class var
+  def description
+    @description ||= self.class.class_variable_get :@@description rescue ''
   end
 
-  def self.name= name
-    @name = name
+  def class_options
+    @class_options ||= self.class.class_variable_get :@@options rescue {}
   end
-  def self.name; @name; end
-  def name; self.class.name.to_sym; end
 
-  # Return ALL available options
+  # task to check that outside dependencies are met before we run the tasks
+  # since verify is not a required method, we define a blank one to prevent undefined method errors
+  #
+  def verify; end
+
+  # validate all options
   #
-  def project_options
-    custom_options = New.custom_config
-    all_options = custom_options.deep_merge(@project_config)
+  def validate
+    class_options.keys.each do |option_name|
+      option_settings = class_options[option_name]
+      option_value = @options[:task_options][option_name]
+      new_option_value = New::Task.validate_option(option_name, option_settings, option_value)
 
-    # 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_config[:tasks].has_key?(task)
+      # set the new validated value
+      @options[:task_options][option_name] = new_option_value
     end
+  end
+
+  # run a system command
+  def run_command command
+    # if verbose, dont redirect output to null
+    command += ' >> /dev/null 2>&1' unless New.verbose
 
-    @project_options ||= all_options
+    # run the command
+    Kernel.system command
   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])
+private
+
+  def initialize name, path
+    @name = name
+    @path = path
   end
 end

data/lib/new/validation.rb

@@ -0,0 +1,191 @@
+module New::Validation
+  # validate a task option using a task and its associated options
+  #
+  # @param option_name  [String]  name of an option
+  # @param option       [Hash]    formatted option object
+  # @param value        [String]  typically a user-input value
+  # @return a valid option value depending on the type/validation rules
+  #         if no valid value can be made, return nil
+  def validate_option option_name, option, value
+    # validate required option or set default
+    if !value || value.empty?
+      # if the option is required, raise an error
+      if option[:required]
+        raise_validation_error option_name, 'is a required option'
+
+      # otherwise set the default
+      else
+        value = option[:default]
+      end
+    end
+
+    # set default type
+    type = option[:type] || String
+
+    # validate and convert value to specified type
+    value = New::Task.validate_class value, type
+
+    # validate with custom validation
+    if validation = option[:validation]
+      value = case
+
+      when type == String
+        validate_regexp option_name, value, validation
+
+      when type == Symbol
+        validate_regexp option_name, value, validation
+
+      when type == Integer
+        validate_range option_name, value, validation
+
+      when type == Float
+        validate_range option_name, value, validation
+
+      when type == Array
+        # set default
+        validation = validation || String
+
+        # If validation is an array convert it to a hash of String
+        if validation.is_a? Array
+          validation_hash = {}
+          validation.each do |v|
+            validation_hash[v] = String
+          end
+          validation = validation_hash
+        end
+
+        # if validation is a hash, make sure all values exist for required keys
+        if validation.is_a? Hash
+          value.each do |v|
+            if validation.keys != v.keys
+              raise_validation_error option_name, "validation for an Array must contain values for `#{validation.keys.join(', ')}`"
+            end
+          end
+        else
+          unless validation == String || validation == Symbol || validation == Boolean || validation == Integer || validation == Float
+            raise_validation_error option_name, "validation for an Array must be a [String|Symbol|Boolean|Integer|Float]"
+          end
+        end
+
+        # validate each element in array with the validation class type
+        value.map! do |v|
+          New::Task.validate_class v, validation
+        end
+
+        return value
+
+      when type == Hash
+        unless validation.is_a?(Array) || validation.is_a?(Hash)
+          raise_validation_error option_name, "validation must be an Array or Hash of required keys (Check the New docs for the requirements)"
+        end
+
+        # make sure value contains all the required validation keys
+        value_keys = (value.is_a?(Array) ? value : value.keys).map(&:to_sym)
+        validation_keys = (validation.is_a?(Array) ? validation : validation.keys).map(&:to_sym)
+        unless (validation_keys & value_keys) == validation_keys
+          raise_validation_error option_name, "must contain all the following keys: #{validation_keys.join(', ')}"
+        end
+
+        # make sure values are of the provided class type
+        if validation.is_a? Hash
+          validation.each do |key, klass|
+            value[key] = New::Task.validate_class value[key], klass
+          end
+        end
+
+        return value
+      else
+        return value
+      end
+    end
+
+    return value
+  end
+
+  def validate_class value, klass
+    begin
+      case
+      when klass == String  then String(value)
+      when klass == Symbol  then validate_symbol value
+      when klass == Boolean then validate_boolean value
+      when klass == Integer then Float(value).to_i
+      when klass == Float   then Float(value)
+      when klass == Array   then value.delete_if{ |v| v == nil || v == '' }
+      when klass == Hash    then value.delete_if{ |k, v| v == nil || v == '' || v == [] }
+      else value
+      end
+    rescue
+      S.ay "`#{value}` cannot be converted to #{klass}", :error
+      raise
+    end
+  end
+
+private
+
+  # convert back to string
+  # convert to lowercase
+  # replace non-alpha characters to underscores
+  # convert consecutive underscores (__) to a single underscore (_)
+  # remove leading underscore
+  # remove trailing underscore
+  #
+  def validate_symbol value
+    begin
+      symbol_name = String(value).downcase.gsub(/[^a-z_]/, '_').gsub(/_+/, '_').sub(/^_/, '').sub(/_$/, '').to_sym
+      raise if symbol_name.empty?
+      symbol_name
+    rescue
+      S.ay "`#{value}` could not be converted into a proper symbol (Check the New docs for rules)", :error
+      raise
+    end
+  end
+
+  def validate_boolean value
+    case value.downcase
+    when 'true', 'yes' then true
+    when 'false', 'no' then false
+    else
+      S.ay "`#{value}` must be either `true/yes` or `false/no`", :error
+      raise
+    end
+  end
+
+  # check that a value matches a regexp
+  #
+  # @param option_name [Symbol] the task option name
+  # @param value [String] the passed user value
+  # @param regexp [Regexp] a regular expression object. defaults to `.*`
+  #
+  def validate_regexp option_name, value, regexp
+    return value unless regexp
+
+    # validate validation
+    raise_validation_error option_name, 'validation must be a `Regexp`' unless regexp.is_a? Regexp
+
+    # check if the value still exists after comparing to the regexp
+    if value[regexp]
+      return value
+    else
+      raise_validation_error option_name, "`#{value}` did not match the regexp `#{regexp.to_s.sub('(?-mix:', '').sub(/\)$/, '')}`."
+    end
+  end
+
+  def validate_range option_name, value, range
+    # if no range is set... any value is valid
+    return value unless range
+
+    # validate validation
+    raise_validation_error option_name, 'validation must be a `Range`' unless range.is_a? Range
+
+    if range.include? value
+      return value
+    else
+      raise_validation_error option_name, "`#{value}` must be within `#{range.min}` and `#{range.max}`"
+    end
+  end
+
+  def raise_validation_error option_name, message
+    S.ay "#{@name.to_s.upcase}: #{option_name}: #{message.white}", :preset => :error
+    raise
+  end
+end

metadata

@@ -1,244 +1,198 @@
 --- !ruby/object:Gem::Specification
 name: new
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.9
 platform: ruby
 authors:
 - Ryan Brewster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-02 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: cli_miami
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: recursive-open-struct
+  name: semantic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: semantic
+  name: sourcerer_
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-description: With custom templates and tasks, quickly create a new project and release
-  it to the world.
-email: brewster1134@gmail.com
+        version: '1.5'
+description: 
+email: 
 executables:
 - new
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".new"
-- ".rspec"
-- Gemfile
-- Gemfile.lock
-- Guardfile
-- LICENSE.txt
-- README.md
 - bin/new
 - lib/new.rb
 - lib/new/cli.rb
-- lib/new/core.rb
-- lib/new/dsl.rb
-- lib/new/interpolate.rb
-- lib/new/project.rb
+- lib/new/source.rb
 - lib/new/task.rb
-- lib/new/template.rb
-- lib/new/version.rb
-- spec/fixtures/custom/.new
-- spec/fixtures/custom/tasks/custom_bar_task/custom_bar_task.rb
-- spec/fixtures/custom/templates/custom_bar_template/.new
-- spec/fixtures/custom/templates/custom_bar_template/custom_bar.txt
-- spec/fixtures/project/.new
-- spec/fixtures/project/.new_cli_release_spec
-- spec/fixtures/tasks/custom_bar_task/custom_bar_task.rb
-- spec/fixtures/tasks/foo_task/Gemfile
-- spec/fixtures/tasks/foo_task/foo_task.rb
-- spec/fixtures/templates/custom_bar_template/.gitkeep
-- spec/fixtures/templates/foo_template/.new
-- spec/fixtures/templates/foo_template/[FOO.BAR].txt.erb
-- spec/fixtures/templates/foo_template/nested_[FOO.BAR]/foo.txt.erb
-- spec/lib/new/cli_spec.rb
-- spec/lib/new/interpolate_spec.rb
-- spec/lib/new/project_spec.rb
-- spec/lib/new/task_spec.rb
-- spec/lib/new/template_spec.rb
-- spec/lib/new/version_spec.rb
-- spec/lib/new_spec.rb
-- spec/spec_helper.rb
-- tasks/gem/.gemspec.erb
-- tasks/gem/README.md
-- tasks/gem/gem.rb
-- tasks/gem/gem_spec.rb
-- templates/js/.bowerrc
-- templates/js/.gitignore
-- templates/js/.new.erb
-- templates/js/CHANGELOG.md
-- templates/js/Gemfile
-- templates/js/Guardfile
-- templates/js/LICENSE-MIT.erb
-- templates/js/README.md.erb
-- templates/js/bower.json.erb
-- templates/js/demo/[PROJECT.FILENAME]_demo.coffee
-- templates/js/demo/[PROJECT.FILENAME]_demo.sass
-- templates/js/demo/index.html.erb
-- templates/js/lib/README.md
-- templates/js/package.json
-- templates/js/spec/[PROJECT.FILENAME]_spec.coffee.erb
-- templates/js/spec/[PROJECT.FILENAME]_spec.sass
-- templates/js/spec/index.html.erb
-- templates/js/src/[PROJECT.FILENAME].coffee.erb
-- templates/js/src/[PROJECT.FILENAME].sass
-- templates/js/testem.yml
-- templates/js/yuyi_menu
+- lib/new/validation.rb
 homepage: https://github.com/brewster1134/new
-licenses:
-- MIT
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -246,29 +200,18 @@ 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.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: A Quick & Custom Project Creation & Release Tool
-test_files:
-- spec/fixtures/custom/tasks/custom_bar_task/custom_bar_task.rb
-- spec/fixtures/tasks/custom_bar_task/custom_bar_task.rb
-- spec/fixtures/tasks/foo_task/foo_task.rb
-- spec/lib/new/cli_spec.rb
-- spec/lib/new/interpolate_spec.rb
-- spec/lib/new/project_spec.rb
-- spec/lib/new/task_spec.rb
-- spec/lib/new/template_spec.rb
-- spec/lib/new/version_spec.rb
-- spec/lib/new_spec.rb
-- spec/spec_helper.rb
+summary: A tool to release your software into the wild.
+test_files: []