neptune_coffee 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5b05ce443964e8ab650ce0c787589d943dc6e76
+  data.tar.gz: 8b0a2df013a6b1b14bd8b430aa50f8229d01d552
+SHA512:
+  metadata.gz: dc0ce6a4a247fd6893cb3aa97d8f534b6ef99031a0c3b8687f65116069cfab3c1921a494c2a5c3184a4651151936c49e90bb408b4a5952a3f4ebbeb1007e0a86
+  data.tar.gz: 226f4651948441d3bd97552094dc143c4c288fed3e118719d5b2e50118c7fc6bd57d1e7e87042cb61d55a968b5e17081f10410dedd3b9ddee8b3a99e228b88aa

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

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shane Brinkman-Davis
+
+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,105 @@
+# NeptuneCoffee
+
+## WORK IN PROGRESS
+This is a work in progress. The basic idea of directories-define-modules is core, as is including the directory_name.js file to included the module. However, the other generated files are still experimental as-is the requirements pattern for module internals.
+
+## What is it?
+
+* opinionated javascript-AMD-module generator
+
+## Purpose
+
+* make working with javascript AMD modules easier
+* minimize refactoring complexity
+* minimize the amount of code you have to write
+
+If you are working with dozens or hundreds of Javascript files, wouldn't you like some way to easily organize them into modules? 
+
+NeptuneCoffee is an opinionated module generator. All you have to do is organize your files into a directory structure where the directory names are module names and the hierarchy reflects sub-modules.
+
+NeptuneCoffee generates the .js files to define your AMD modules.
+
+## Optionated?
+NeptuneCoffee has an opinion about how you should organize your javascript for AMD modules. It is:
+
+* Directories are AMD modules
+* Directory names the AMD module names
+* Directory names snake_case
+* generated AMD module names are CamelCase
+* require "foo/bar" includes all files in the module defined by the directory "foo/bar"
+* Defines a global namespace for accessing AMD modules: window.Neptune.YourRootModule.YourSubModule
+
+## Benefit
+
+Refactoring module structure is as simple as renaming and moving directories and files. Often you won't have to change a line of code.
+
+## What does it do?
+
+For every $subdir, NeptuneCoffee generates:
+
+	$subdir/neptune.js    // loads and attaches all sub-namespaces to $subdir's namespace object
+	$subdir/namespace.js  // defines $subdir's namespace object
+	$subdir.js            // loads all .js files in $subdir recursively
+	                      // all three files return $subdir's namespace object
+
+# How to Use
+
+Install neptune_coffee (see below). Then, whenever your directory structure changes or you move/add/rename/delete files, run:
+    
+    neptune_coffee -r source/root
+
+* Client should require: **$subdir.js** for the AMD module **source/root/$subdir**
+* Source files in **source/root/$subdir/** should require: **$subdir/neptune.js** or **$subdir/namespace.js**
+
+## Example
+
+Given this directory structure and files:
+
+    geometry/solids/cone.js
+    geometry/box.js    
+    geometry/circle.js
+    
+NeptineCoffee generates:
+
+	geometry.js
+	geometry/namespace.js
+	geometry/neptune.js
+	geometry/solids.js
+	geometry/solids/namespace.js
+	geometry/solids/neptune.js
+
+geometry.js might look like:
+
+	// Generated by NeptuneCoffee 0.0.1
+	define([
+	  "geometry/namespace",
+	  "geometry/box",
+	  "geometry/circle",
+	  "geometry/neptune",
+	  "geometry/solids"
+	  ], function(Geometry) {
+	  return Geometry;
+	});
+    
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'neptune_coffee'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install neptune_coffee
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/neptune_coffee

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby
+
+require 'trollop'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','neptune_coffee'))
+
+options = Trollop::options ARGV do
+  banner <<ENDBANNER
+NeptuneCoffee
+
+An opinionated javascript AMD module generator.
+
+For every $subdir, generates:
+  $subdir/neptune.js    // adds all sub-namespaces to $subdir's namespace object
+  $subdir/namespace.js  // defines $subdir's namespace object
+  $subdir.js            // loads all .js files in $subdir recursively
+
+* All three generated files return $subdir's namespace object.
+* Client's should require $subdir.js.
+* Source files in $subdir/ should require $subdir/neptune.js
+
+Options:
+ENDBANNER
+
+  opt :root, "recursively generate files in root and all subdirectories", :type => :string
+  opt :force, "force file generation"
+  opt :overwrite, "overwrite all existing files. Otherwise, generated/source-file name conflicts report a warning and do not overwrite the source."
+  opt :files, "(DEBUG) only generate these files", :type => :strings
+  opt :dirs, "(DEBUG) show dirs affected by files option (no actions are taken)"
+  opt :verbose, "show contents of generated files"
+end
+
+Trollop::die "root options is required" unless options.root
+Trollop::die "dirs option requires files option" if options.dirs and not options.files
+
+generator = NeptuneCoffee::Generator.new options
+if options.dirs
+  puts "files: #{options.files.join ', '}"
+  puts "effects: #{generator.dirs_effected(options.files).inspect}"
+elsif options.files
+  generator.generate_on_changes options.files
+else
+  generator.generate_all
+end

data/examples/geometry/box.js

@@ -0,0 +1,4 @@
+// example source file
+function(){
+  window.box = "box";
+}();

data/examples/geometry/circle.js

@@ -0,0 +1,4 @@
+// example source file
+function(){
+  window.circle = "circle";
+}();

data/examples/geometry/namespace.js

@@ -0,0 +1,2 @@
+// Generated by NeptuneCoffee 0.0.1
+define([], function() {return window;})

data/examples/geometry/neptune.js

@@ -0,0 +1,8 @@
+// Generated by NeptuneCoffee 0.0.1
+define([
+  "./solids/neptune"
+], function(Solids) {
+  Neptune = window.Neptune = {};
+  Neptune.Solids = Solids; Solids.namespace = Neptune;
+  return Neptune;
+});

data/examples/geometry/solids/cone.js

@@ -0,0 +1,4 @@
+// example source file
+function(){
+  window.cone = "cone";
+}();

data/examples/geometry/solids/namespace.js

@@ -0,0 +1,8 @@
+// Generated by NeptuneCoffee 0.0.1
+define(["namespace"], function(Root) {
+  return Root.Solids = (function() {
+    function Solids() {}
+    Solids.namespace = Root;
+    return Solids;
+  })();
+});

data/examples/geometry/solids/neptune.js

@@ -0,0 +1,6 @@
+// Generated by NeptuneCoffee 0.0.1
+define([
+  "solids/namespace"
+], function(Solids) {
+  return Solids;
+});

data/examples/geometry/solids.js

@@ -0,0 +1,8 @@
+// Generated by NeptuneCoffee 0.0.1
+define([
+  "solids/namespace",
+  "solids/cone",
+  "solids/neptune"
+  ], function(Solids) {
+  return Solids;
+});

data/examples/geometry.js

@@ -0,0 +1,10 @@
+// Generated by NeptuneCoffee 0.0.1
+define([
+  "geometry/namespace",
+  "geometry/box",
+  "geometry/circle",
+  "geometry/neptune",
+  "geometry/solids"
+  ], function(Geometry) {
+  return Geometry;
+});

data/lib/neptune_coffee/generator.rb

@@ -0,0 +1,197 @@
+require 'extlib'
+require 'guard/guard'
+require "coderay"
+
+module ::Guard
+  module UI
+    class << self
+      def success(message, options = {})
+          _filtered_logger_message(message, :info, :green, options)
+      end
+    end
+  end
+end
+
+module NeptuneCoffee
+  class Generator
+
+    SAFE_GENERATE_FIRST_LINE = "// Generated by NeptuneCoffee"
+
+    def initialize(options)
+      @root = options[:root].chomp "/"
+      @force = options[:force]
+      @verbose = options[:verbose]
+      @overwrite = options[:overwrite]
+      reset_file_info
+    end
+
+    attr_accessor :root
+
+    def error(message)    Guard::UI.error "NeptuneCoffee: "+message; end
+    def warning(message)  Guard::UI.warning "NeptuneCoffee: "+message; end
+    def info(message)     Guard::UI.info "NeptuneCoffee: "+message; end
+    def success(message)  Guard::UI.success "NeptuneCoffee: "+message; end
+
+    def in_root
+      Dir.chdir @root do
+        yield
+      end
+    end
+
+    def reset_file_info
+      @generated_files = {}
+      @to_generate_files = {}
+      @current_files = {}
+      @skipped_files = {}
+    end
+
+    def generate_all
+      reset_file_info
+      success "generating all files in: #{@root}"
+      generate_on_changes Dir.glob "#{@root}/**/*.js"
+      success "#{@current_files.length}/#{@to_generate_files.length} files current"
+      success "#{@generated_files.length} files geneated" if @generated_files.length > 0
+      warning "#{@skipped_files.length} files skipped (this is a name conflict. We recommend renaming your source file(s)." if @skipped_files.length> 0
+    end
+
+    def dirs_effected files
+      dirs = files.map do |path|
+        p = path.split(@root+"/", 2)[1] || ""
+        dir = File.dirname p
+        subdir = join dir, File.basename(p, File.extname(p))
+        if subdir.length>0 && File.directory?(join @root, subdir)
+          [dir,subdir]
+        else
+          dir
+        end
+      end.flatten.uniq.sort.reverse
+    end
+
+    def generate_on_changes(paths)
+      dirs = dirs_effected paths
+      in_root do
+        dirs.each do |dir|
+          generate_neptune dir
+          generate_namespace dir
+          generate_loader dir
+        end
+      end
+    end
+
+    def file_is_safe_to_overwrite file
+      return true unless File.exists? file
+      File.open(file, "r") do |file|
+        return SAFE_GENERATE_FIRST_LINE == file.read(SAFE_GENERATE_FIRST_LINE.length)
+      end
+      false
+    end
+
+    def safe_generate file
+      @to_generate_files[file] = true
+      return if !File.exists? File.dirname file
+      info_file = join @root, file.split(@root)[-1]
+      if @overwrite || file_is_safe_to_overwrite(file)
+        new_contents = SAFE_GENERATE_FIRST_LINE + " #{NeptuneCoffee::VERSION}\n" + yield
+        if @force || !File.exists?(file) || (File.read(file) != new_contents)
+          @generated_files[file] = true
+          success "generating: #{info_file}"
+          highlighted = CodeRay.scan(new_contents, :javascript).terminal
+          info "output:\n    "+highlighted.gsub("\n","\n    ") if @verbose
+          File.write file, new_contents
+        else
+          @current_files[file] = true
+          # success "unchanged:  #{info_file}"
+        end
+      else
+        @skipped_files[file] = true
+        warning "skipping:   #{info_file}"
+      end
+    end
+
+    def js_files_to_load dir
+      files = Dir.glob(dir+"/*.js").map {|f| f.chomp ".js"}
+      files.select {|file| !file[/\/namespaces?$/]}.sort
+    end
+
+    def generate_loader dir
+      return if dir == "."
+      files = js_files_to_load dir
+      files = [join(dir, "namespace")]+files
+      namespace_name = File.basename(dir).camel_case
+      safe_generate dir+".js" do
+        <<-ENDJS
+define([
+  "#{files.join "\",\n  \""}"
+  ], function(#{namespace_name}) {
+  return #{namespace_name};
+});
+ENDJS
+      end
+    end
+
+    def join(dir, file)
+      if dir == "." || dir == ""
+        file
+      else
+        File.join dir, file
+      end
+    end
+
+    def sub_namespaces_to_include dir
+      Dir.glob(dir+"/*").select {|f| File.directory?(f) && File.exists?(File.join f, "namespace.js")}.sort
+    end
+
+    def generate_neptune dir
+      path = join dir, "neptune.js"
+      root = dir == "."
+      sub_namespaces = sub_namespaces_to_include dir
+      camel_subs = sub_namespaces.map {|s| s.split("/")[-1].camel_case}
+      subs_files = sub_namespaces.map {|s| File.join s, "neptune"}
+      namespace_name = File.basename(dir).camel_case
+      namespace_name = "Neptune" if dir == "."
+      subs_files = [join(dir, "namespace")]+subs_files unless root
+      function_params = camel_subs
+      function_params = [namespace_name] + function_params unless root
+      safe_generate path do
+        <<-ENDJS
+define([
+  "#{subs_files.join "\",\n  \""}"
+], function(#{function_params.join ", "}) {#{"
+  Neptune = window.Neptune = {};" if root}#{
+  camel_subs.map do |s|"
+  #{namespace_name}.#{s} = #{s}; #{s}.namespace = #{namespace_name};"
+  end.join
+  }
+  return #{namespace_name};
+});
+ENDJS
+      end
+    end
+
+
+    def generate_namespace dir
+      path = join dir, "namespace.js"
+      parent_namespace_name = File.basename(File.dirname dir).camel_case
+      parent_namespace_name = "Root" if parent_namespace_name == "."
+      namespace_name = File.basename(dir).camel_case
+      safe_generate path do
+        if dir == "." || dir == ""
+          <<-ENDJS
+define([], function() {return window;})
+ENDJS
+        else
+          parent_namespace = join File.dirname(dir), "namespace"
+          <<-ENDJS
+define(["#{parent_namespace}"], function(#{parent_namespace_name}) {
+  return #{parent_namespace_name}.#{namespace_name} = (function() {
+    function #{namespace_name}() {}
+    #{namespace_name}.namespace = #{parent_namespace_name};
+    return #{namespace_name};
+  })();
+});
+ENDJS
+        end
+      end
+    end
+  end
+end

data/lib/neptune_coffee/version.rb

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

data/lib/neptune_coffee.rb

@@ -0,0 +1,9 @@
+%w{
+  version
+  generator
+}.each do |mod|
+  require File.join(File.dirname(__FILE__),"neptune_coffee", mod)
+end
+
+module NeptuneCoffee
+end

data/neptune_coffee.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'neptune_coffee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "neptune_coffee"
+  spec.version       = NeptuneCoffee::VERSION
+  spec.authors       = ["Shane Brinkman-Davis"]
+  spec.email         = ["shanebdavis@gmail.com"]
+  spec.description   = %q{Opinonated CoffeeScript client-side development}
+  spec.summary       = %q{NeptuneCoffee is an opinionated module generator. All you have to do is organize your files into a directory structure where the directory names are module names and the hierarchy reflects sub-modules.}
+  spec.homepage      = ""
+  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_dependency "trollop"
+  spec.add_dependency "extlib"
+  spec.add_dependency "coderay"
+  spec.add_dependency "guard"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: neptune_coffee
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shane Brinkman-Davis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: extlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Opinonated CoffeeScript client-side development
+email:
+- shanebdavis@gmail.com
+executables:
+- neptune_coffee
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/neptune_coffee
+- examples/geometry.js
+- examples/geometry/box.js
+- examples/geometry/circle.js
+- examples/geometry/namespace.js
+- examples/geometry/neptune.js
+- examples/geometry/solids.js
+- examples/geometry/solids/cone.js
+- examples/geometry/solids/namespace.js
+- examples/geometry/solids/neptune.js
+- lib/neptune_coffee.rb
+- lib/neptune_coffee/generator.rb
+- lib/neptune_coffee/version.rb
+- neptune_coffee.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.0.7
+signing_key: 
+specification_version: 4
+summary: NeptuneCoffee is an opinionated module generator. All you have to do is organize
+  your files into a directory structure where the directory names are module names
+  and the hierarchy reflects sub-modules.
+test_files: []