neptune_coffee 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ff1151257434e5c05e89d3d20a1427855bcffe9
-  data.tar.gz: c82d36f075b2dac5318673ff94a949ceb8c22e17
+  metadata.gz: 81dfeb0fbd08d00d2daeaf9a9ae6015c0f334688
+  data.tar.gz: bb03a3648574f04bf67c311a6e5f17b9bc2629fe
 SHA512:
-  metadata.gz: dd73fc52706441254c998c95dc08731520d9dc2ed2ca33902a5a38208f3934a70a74c24e13b7bd1196ae0bea8f825f7384a7ddf51599be3cd4c1447da689158b
-  data.tar.gz: 58bb0b73e9a40ddaacd23683cfd31dfeffc9f66bd0d692612772916f03ef1aea0e972d74bf7d14fecc5ceaca4e146b513479d459d4f5b20e255233e68d066f99
+  metadata.gz: dfae5c029030739c73c71ffcfc93c7813b7dc1e55987cca192e27364edaaba8ce97d0c5ed44647d1973ec71fcf67b8353151d6de3a3119e43ba12664a5687330
+  data.tar.gz: 609a3469a38bc070b7c8f25f4a98b6e97be0414297cd210c42f7916c5b75d3983bbbd06eeff2a4213989986c2039436a0f08195ce1e82ce6fa3c904a463f30e3

data/CHANGELOG.md

@@ -1,8 +1,15 @@
 # Neptune Coffee Changelog
 
+### v0.2.5
+
+Added: rake reset_examples
+
+Changed generated 'namespace.js' semantics. It no longer includes sub-
+namespaces. Include the generated module file to get all sub-namespaces.
+
 ### v0.2.4
 
-Updated Generator#generate_all to now return a Hash of Arrays (instead Hash of Hashes)
+Updated Generator#generate_all to now return a Hash of Arrays (instead Hash of Hashes).
 
 ### v0.2.3
 

data/Rakefile

@@ -1,4 +1,5 @@
 require "bundler/gem_tasks"
+require "pathname"
 
 require 'rspec'
 require 'rspec/core/rake_task'
@@ -12,4 +13,21 @@ RSpec::Core::RakeTask.new('spec') do |t|
   t.verbose = true
 end
 
+desc "Regenerate examples/after based on examepls/before"
+task :reset_examples do
+  root = Pathname.new(__FILE__).parent.relative_path_from Pathname.pwd
+  binary = root + "bin/neptune_coffee"
+  examples = root + "examples"
+  examples_before = examples + "before"
+  examples_after = examples + "after"
+  puts "rm -r #{examples_after}"
+  examples_after.rmtree
+  command = "cp -v -R #{examples_before} #{examples_after}"
+  puts command
+  system command
+  # `#{command}`
+  command = "#{binary} -o -r #{examples_after}"
+  `#{command}`
+end
+
 task :default => :spec

data/TODO.md

@@ -0,0 +1,58 @@
+# Neptune Coffee Todo
+
+## .directories (dot-directories)
+
+#### Goals
+* Support putting test files inside the directory of the module they are testing.
+* Reduce management and refactoring complexity: Just move the module's directory and all its tests move with it.
+* Make it easy to load the test files of one module, and all its sub-modules.
+* Make it so you don't have to load all test files globally.
+* Make a general solution so many different types of cross-cutting, non-production support files can be co-located within their modules. For example, performance-testing is separate from correctness testing. 
+
+#### Status Quo
+
+* Currently requiring a module includes all js files in all sub-directories. This makes it impossible to co-locate test files in the same structure unless you want the test files deployed to production.
+* Currently all tests are loaded at once, globally. This is getting awkward and slow. Mocha supports only running selected tests, but the current system sill loads all test and, consequently, all source-code. Combine that with live-reload and there is a lot of uneccessary work being done with every red-green test cycle.
+* Currently directories that start with a dot don't work at all. It generates namespaces that start with a "." - illegal in javascript. 
+
+#### Propsed Solution
+
+* Place your test files in a subdirectory named ".test"
+* Directories that start with a dot are treated specially:
+  * They are not included by default when requiring a parent module-directory.
+  * They must be explicitly required: require ".test"
+  * They are linked into the NeptuneCoffee namespace structure as-if their directory-name didn't have a ".". Ex: ".test" becomes the Test namespace under its parent directory
+* NOTE: You shouldn't have both "test" and ".test" subdirs under the same parent.
+* To included all dot-directories of the same name anywhere under a parent-directory, require the parent-directory's path and name concatinated with the dot-directory's name. Ex:
+	* Directory structure:
+		* foo
+		* foo/.test
+		* foo/.perf
+		* foo/bar
+		* foo/bar/.test
+		* foo/bar/.perf
+	* require ["foo.test"], (Foo) -> 
+		* imports all .test directories in foo and all its sub-directories
+		* returns Foo, with (at-least) the following namespaces set:
+			* Foo.Bar
+			* Foo.Test
+			* Foo.Bar.Test	
+	* require ["foo.perf"], (Foo) -> 
+		* imports all .perf directories in foo and all its sub-directories
+		* returns Foo, with (at-least) the following namespaces set:
+			* Foo.Bar
+			* Foo.Perf
+			* Foo.Bar.Perf
+	* require ["foo", "foo.perf", "foo.test"], (Foo, FooPerf, FooTest) -> 
+		* Foo == FooPerf == FooTest
+		* returns Foo, with (at-least) the following namespaces set:
+			* Foo.Bar
+			* Foo.Perf
+			* Foo.Bar.Perf
+			* Foo.Test
+			* Foo.Bar.Test	
+		
+## don't generate files for directories with no JavaScript files		
+## Auto-delete generated files no longer needed
+## should we support CSS concatination?
+## including a namespace file and one JavaScript file in that namespace doesn't guarantee the JavaScript file's return value is attached to that namespace.

data/examples/after/geometry.js

@@ -1,12 +1,13 @@
-// Generated by NeptuneCoffee 0.2.3
+// Generated by NeptuneCoffee 0.3.0
 // path: geometry.js
 define([
   './geometry/namespace',
   './geometry/box',
   './geometry/circle',
   './geometry/solids'
-], function(Geometry, Box, Circle) {
+], function(Geometry, Box, Circle, Solids) {
   if (typeof Box == 'function') {Geometry.Box = Box; Box.namespace = Geometry;}
   if (typeof Circle == 'function') {Geometry.Circle = Circle; Circle.namespace = Geometry;}
+  if (typeof Solids == 'function') {Geometry.Solids = Solids; Solids.namespace = Geometry;}
   return Geometry;
-});
+});

data/examples/after/geometry/namespace.js

@@ -1,12 +1,9 @@
-// Generated by NeptuneCoffee 0.2.3
+// Generated by NeptuneCoffee 0.3.0
 // path: geometry/namespace.js
-define([
-  './solids/namespace'
-], function(Solids) {
+define([], function() {
   var Geometry = (function() {
     function Geometry() {}
     return Geometry;
   })();
-  Geometry.Solids = Solids; Solids.namespace = Geometry;
   return Geometry;
-});
+});

data/examples/after/geometry/solids.js

@@ -1,4 +1,4 @@
-// Generated by NeptuneCoffee 0.2.3
+// Generated by NeptuneCoffee 0.3.0
 // path: geometry/solids.js
 define([
   './solids/namespace',
@@ -6,4 +6,4 @@ define([
 ], function(Solids, Cone) {
   if (typeof Cone == 'function') {Solids.Cone = Cone; Cone.namespace = Solids;}
   return Solids;
-});
+});

data/examples/after/geometry/solids/namespace.js

@@ -1,4 +1,4 @@
-// Generated by NeptuneCoffee 0.2.3
+// Generated by NeptuneCoffee 0.3.0
 // path: geometry/solids/namespace.js
 define([], function() {
   var Solids = (function() {
@@ -6,4 +6,4 @@ define([], function() {
     return Solids;
   })();
   return Solids;
-});
+});

data/examples/after/namespace.js

@@ -1,12 +1,9 @@
-// Generated by NeptuneCoffee 0.2.3
+// Generated by NeptuneCoffee 0.3.0
 // path: namespace.js
-define([
-  './geometry/namespace'
-], function(Geometry) {
+define([], function() {
   var Neptune = (function() {
     function Neptune() {}
     return Neptune;
   })();
-  Neptune.Geometry = Geometry; Geometry.namespace = Neptune;
   return Neptune;
-});
+});

data/lib/neptune_coffee/generators/module.js.erb

@@ -0,0 +1,14 @@
+<%
+class_files = class_files.map{|f|f.sub_ext("")}.select {|c|c.basename.to_s!="namespace"}.sort.uniq
+files = [dir + "namespace"] + class_files + subdirs.sort.uniq
+file_class_names = class_files.map {|files| files.basename.to_s.camel_case}
+
+sub_namespaces = subdirs.map {|files| files.basename.to_s.camel_case}
+
+define_js files_relative_to(files, dir.dirname), [namespace_name]+file_class_names+sub_namespaces do
+  (file_class_names+sub_namespaces).map do |fcn| %>
+  <%= "if (typeof #{fcn} == 'function') {#{namespace_name}.#{fcn} = #{fcn}; #{fcn}.namespace = #{namespace_name};}" %><%
+  end
+  %>
+  return <%= namespace_name %>;
+<% end %>

data/lib/neptune_coffee/generators/namespace.js.erb

@@ -0,0 +1,8 @@
+<%
+define_js [], [] do %>
+  var <%= namespace_name %> = (function() {
+    function <%= namespace_name %>() {}
+    return <%= namespace_name %>;
+  })();
+  return <%= namespace_name %>;
+<% end %>

data/lib/neptune_coffee/guard.rb

@@ -1,4 +1,4 @@
-require 'guard/guard'
+require 'guard'
 
 module ::Guard
   module UI

data/lib/neptune_coffee/javascript_generator.rb

@@ -1,32 +1,55 @@
+require "pathname"
+require "erb"
+
 module NeptuneCoffee
   class JavascriptGenerator
-    attr_accessor :root, :dir
+    class <<self
+      attr_accessor :generators
+      def load_erb
+        generator_root = Pathname.new(__FILE__).parent + "generators"
+        @generators = {}
+        generator_root.children(false).each do |erb_file|
+          name = erb_file.to_s.split(/\.erb$/)[0]
+          path = generator_root + erb_file
+          @generators[name] = ERB.new path.read, nil, "<>-"
+          @generators[name].filename = erb_file
+        end
+      end
+    end
+    JavascriptGenerator.load_erb
+
+    attr_accessor :root, :dir, :class_files, :subdirs
     def initialize root, dir
       @root = root
       @dir = dir
     end
 
-    def define_js files, relative_to_path
-      files_js = files.length == 0 ? "" : files.map{|f| "\n  './#{f.relative_path_from(relative_to_path)}'"}.join(",") + "\n"
-      "define([#{files_js}], function"
+    def files_relative_to files, relative_to_path
+      files.map {|f| f.relative_path_from relative_to_path}
+    end
+
+    def define_js relative_file_paths, local_names
+      files_js = if relative_file_paths.length == 0 then ""
+      else
+        "\n  " + relative_file_paths.map{|f| "'./#{f}'"}.join(",\n  ") + "\n"
+      end
+
+      old_buffer, @output_buffer = @output_buffer, ''
+      begin
+        content = yield
+      ensure
+        @output_buffer = old_buffer
+      end
+
+      @output_buffer << "define([#{files_js}], function(#{local_names.join ', '}) {#{content}});"
     end
 
-    def module sub_modules, class_files
-      # subfiles ||= dir.children.select{|c| !c.directory? && c.extname == ".js"}
-      class_files = class_files.map{|f|f.sub_ext("")}.select {|c|c.basename.to_s!="namespace"}.sort.uniq
-      files = [dir + "namespace"] + class_files + sub_modules.sort.uniq
-
-      file_class_names = class_files.map {|files| files.basename.to_s.camel_case}
-
-      <<-ENDJS
-#{define_js files, dir.dirname}(#{([namespace_name]+file_class_names).join ', '}) {#{
-  file_class_names.map do |fcn|
-    "\n  if (typeof #{fcn} == 'function') {#{namespace_name}.#{fcn} = #{fcn}; #{fcn}.namespace = #{namespace_name};}"
-  end.join
-  }
-  return #{namespace_name};
-});
-ENDJS
+    def module subdirs, class_files
+      @output_buffer = ""
+      @subdirs = subdirs
+      @class_files = class_files
+      JavascriptGenerator.generators["module.js"].result(binding)
+      @output_buffer
     end
 
     def namespace_name
@@ -34,23 +57,10 @@ ENDJS
     end
 
     def namespace subdirs
-      sub_namespace_files = subdirs.map {|subdirs| subdirs + "namespace"}
-
-      sub_namespaces = subdirs.map {|files| files.basename.to_s.camel_case}
-
-      <<-ENDJS
-#{define_js sub_namespace_files, dir}(#{sub_namespaces.join ', '}) {
-  var #{namespace_name} = (function() {
-    function #{namespace_name}() {}
-    return #{namespace_name};
-  })();#{
-  sub_namespaces.map do |sns|
-    "\n  #{namespace_name}.#{sns} = #{sns}; #{sns}.namespace = #{namespace_name};"
-  end.join
-  }
-  return #{namespace_name};
-});
-ENDJS
+      @output_buffer = ""
+      @subdirs = subdirs
+      JavascriptGenerator.generators["namespace.js"].result(binding)
+      @output_buffer
     end
   end
 end

data/lib/neptune_coffee/version.rb

@@ -1,3 +1,3 @@
 module NeptuneCoffee
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

data/neptune_coffee.gemspec

@@ -18,12 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trollop"
-  spec.add_dependency "extlib"  # for camel_case
-  spec.add_dependency "coderay"
-  spec.add_dependency "guard"
+  spec.add_dependency "trollop", "~> 2.0"
+  spec.add_dependency "extlib" , "~> 0.9"  # for camel_case
+  spec.add_dependency "coderay", "~> 1.1"
+  spec.add_dependency "guard"  , "2.2"
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec', '~> 2.14.0'
+  spec.add_development_dependency "rake",    "~> 10.1"
+  spec.add_development_dependency 'rspec',   '~> 2.14.0'
 end

data/spec/javascript_generator_spec.rb

@@ -21,8 +21,8 @@ describe JavascriptGenerator do
       Pathname["foo/bar/file2"]
     ]
 
-    module_js.should == <<ENDJS
-define([
+    module_js.should ==
+"define([
   './bar/namespace',
   './bar/file1',
   './bar/file2',
@@ -32,41 +32,33 @@ define([
   if (typeof File1 == 'function') {Bar.File1 = File1; File1.namespace = Bar;}
   if (typeof File2 == 'function') {Bar.File2 = File2; File2.namespace = Bar;}
   return Bar;
-});
-ENDJS
+});"
   end
 
   it "namespace_js" do
     namespace_js = JavascriptGenerator.new(Pathname["foo"], Pathname["foo/bar"]).namespace [
       Pathname["foo/bar/sub_dir1"], Pathname["foo/bar/sub_dir2"]
     ]
-    namespace_js.should == <<ENDJS
-define([
-  './sub_dir1/namespace',
-  './sub_dir2/namespace'
-], function(SubDir1, SubDir2) {
+    namespace_js.should ==
+"define([], function() {
   var Bar = (function() {
     function Bar() {}
     return Bar;
   })();
-  Bar.SubDir1 = SubDir1; SubDir1.namespace = Bar;
-  Bar.SubDir2 = SubDir2; SubDir2.namespace = Bar;
   return Bar;
-});
-ENDJS
+});"
   end
 
   it "namespace_js with no subdirs" do
     namespace_js = JavascriptGenerator.new(Pathname["foo"], Pathname["foo/bar"]).namespace []
-    namespace_js.should == <<ENDJS
-define([], function() {
+    namespace_js.should ==
+"define([], function() {
   var Bar = (function() {
     function Bar() {}
     return Bar;
   })();
   return Bar;
-});
-ENDJS
+});"
   end
 
 end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: neptune_coffee
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Shane Brinkman-Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: extlib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !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'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
 description: opinionated javascript-AMD-module generator
@@ -116,12 +116,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/neptune_coffee
 - examples/after/geometry.js
 - examples/after/geometry/box.js
@@ -136,6 +137,8 @@ files:
 - examples/before/geometry/solids/cone.js
 - lib/neptune_coffee.rb
 - lib/neptune_coffee/generator.rb
+- lib/neptune_coffee/generators/module.js.erb
+- lib/neptune_coffee/generators/namespace.js.erb
 - lib/neptune_coffee/guard.rb
 - lib/neptune_coffee/javascript_generator.rb
 - lib/neptune_coffee/simple_directory_structure.rb
@@ -156,17 +159,17 @@ 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
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: NeptuneCoffee is an opinionated module generator. Modules and namespaces