jsus 0.1.22 → 0.2.0

data/CHANGELOG

@@ -1,4 +1,9 @@
 = Jsus Changelog
+== Version 0.2.0
+* Support for mooforge validator (checks if every file has authors && license),
+  more validators at request
+* Errors on source files should now be easier to track down
+
 == Version 0.1.21
 * Support for wildcards in requires statements (beware, something could break)
 

data/Gemfile.lock

@@ -5,34 +5,30 @@ GEM
     choice (0.1.4)
     diff-lcs (1.1.2)
     git (1.2.5)
-    haml (3.0.24)
-    jeweler (1.5.1)
+    haml (3.0.25)
+    jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
     json_pure (1.4.6)
-    murdoc (0.1.3)
+    murdoc (0.1.5)
       haml (~> 3.0.0)
       haml (~> 3.0.0)
-      jeweler
       rdiscount (~> 1.6.5)
       rdiscount (~> 1.6.5)
-      rspec (~> 2.1.0)
-      sass (~> 3.1.0)
     rake (0.8.7)
     rdiscount (1.6.5)
     rgl (0.4.0)
       rake
       stream (>= 0.5)
-    rspec (2.1.0)
-      rspec-core (~> 2.1.0)
-      rspec-expectations (~> 2.1.0)
-      rspec-mocks (~> 2.1.0)
-    rspec-core (2.1.0)
-    rspec-expectations (2.1.0)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
-    sass (3.1.0.alpha.39)
+    rspec-mocks (2.4.0)
     stream (0.5)
 
 PLATFORMS

data/Rakefile

@@ -19,10 +19,6 @@ Jeweler::Tasks.new do |gem|
   gem.description = "Javascript packager and dependency resolver"
   gem.email = "markizko@gmail.com"
   gem.authors = ["Mark Abramov"]
-  gem.add_runtime_dependency "activesupport"
-  gem.add_runtime_dependency "json_pure"
-  gem.add_runtime_dependency "rgl"
-  gem.add_runtime_dependency "choice"
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/TODO

@@ -1,2 +1,3 @@
 * Disallow circular dependencies
-* Rails integration
+* Rails integration
+* Cleanup jsus utility

data/VERSION

@@ -1 +1 @@
-0.1.22
+0.2.0

data/bin/jsus

@@ -12,6 +12,8 @@ require 'choice'
 start_time = Time.now
 
 Choice.options do
+  header "Jsus version #{Jsus.version}"
+  
   option 'input_directory', :required => true do
     short "-i"
     long "--input-directory=DIRECTORY"
@@ -79,6 +81,12 @@ Choice.options do
     desc "When verbose mode is enabled, some debug information is displayed. Defaults to false."
   end
 
+  option "validate_with", :required => false do
+    default []
+    long "--validate-with *VALIDATORS"
+    desc "performs validation of the resulting source. " <<
+         "Available validators: mooforge"
+  end
 end
 
 compile_start_time = Time.now
@@ -88,6 +96,8 @@ Jsus.verbose = Choice.choices[:verbose]
 pool_load_start_time = Time.now
 pool = if Choice.choices[:dependencies]
   Jsus::Pool.new(Choice.choices[:dependencies])
+else
+  Jsus::Pool.new
 end
 pool_load_finish_time = Time.now
 
@@ -98,6 +108,19 @@ package.compile(output_directory)
 package.generate_scripts_info(output_directory) unless Choice.choices[:without_scripts_info]
 package.generate_tree(output_directory) unless Choice.choices[:without_tree]
 
+# Validations
+validators_map = {"mooforge" => Jsus::Validator::Mooforge}
+Choice.choices[:validate_with].each do |validator_name|
+  if validator = validators_map[validator_name.downcase]
+    errors = validator.new(pool.sources.to_a & package.source_files.to_a).validation_errors
+    unless errors.empty?
+      puts "Validator found errors: "
+      errors.each {|e| puts "  * #{e}"}
+    end
+  else
+    puts "No such validator: #{validator_name}"
+  end
+end
 
 # Hack, hack, hack :[
 if Choice.choices[:generate_includes]

data/jsus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jsus}
-  s.version = "0.1.22"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Abramov"]
-  s.date = %q{2010-11-28}
+  s.date = %q{2011-01-15}
   s.default_executable = %q{jsus}
   s.description = %q{Javascript packager and dependency resolver}
   s.email = %q{markizko@gmail.com}
@@ -42,6 +42,9 @@ Gem::Specification.new do |s|
     "lib/jsus/source_file.rb",
     "lib/jsus/tag.rb",
     "lib/jsus/tree.rb",
+    "lib/jsus/validator.rb",
+    "lib/jsus/validator/base.rb",
+    "lib/jsus/validator/mooforge.rb",
     "markup/index_template.haml",
     "markup/stylesheet.css",
     "markup/template.haml",
@@ -86,6 +89,14 @@ Gem::Specification.new do |s|
     "spec/data/JsonPackage/Source/SheetParser.CSS.js",
     "spec/data/JsonPackage/Source/sg-regex-tools.js",
     "spec/data/JsonPackage/package.json",
+    "spec/data/MooforgeValidation/README",
+    "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoAuthors.js",
+    "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoLicense.js",
+    "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/Valid.js",
+    "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Widget/Input/Input.Color.js",
+    "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Widget/Input/Input.js",
+    "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Widget/Widget.js",
+    "spec/data/MooforgeValidation/app/javascripts/Orwik/package.yml",
     "spec/data/OutsideDependencies/README",
     "spec/data/OutsideDependencies/app/javascripts/Core/Source/Class/Class.Extras.js",
     "spec/data/OutsideDependencies/app/javascripts/Core/Source/Class/Class.js",
@@ -107,6 +118,8 @@ Gem::Specification.new do |s|
     "spec/jsus/source_file_spec.rb",
     "spec/jsus/tag_spec.rb",
     "spec/jsus/tree_spec.rb",
+    "spec/jsus/validator/base_spec.rb",
+    "spec/jsus/validator/mooforge_spec.rb",
     "spec/shared/class_stubs.rb",
     "spec/spec_helper.rb"
   ]
@@ -124,6 +137,8 @@ Gem::Specification.new do |s|
     "spec/jsus/source_file_spec.rb",
     "spec/jsus/tag_spec.rb",
     "spec/jsus/tree_spec.rb",
+    "spec/jsus/validator/base_spec.rb",
+    "spec/jsus/validator/mooforge_spec.rb",
     "spec/shared/class_stubs.rb",
     "spec/spec_helper.rb"
   ]
@@ -141,10 +156,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<murdoc>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<json_pure>, [">= 0"])
-      s.add_runtime_dependency(%q<rgl>, [">= 0"])
-      s.add_runtime_dependency(%q<choice>, [">= 0"])
     else
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<json_pure>, [">= 0"])
@@ -154,10 +165,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<murdoc>, [">= 0"])
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<json_pure>, [">= 0"])
-      s.add_dependency(%q<rgl>, [">= 0"])
-      s.add_dependency(%q<choice>, [">= 0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 0"])
@@ -168,10 +175,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<murdoc>, [">= 0"])
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<json_pure>, [">= 0"])
-    s.add_dependency(%q<rgl>, [">= 0"])
-    s.add_dependency(%q<choice>, [">= 0"])
   end
 end
 

data/lib/jsus.rb

@@ -18,6 +18,7 @@ require 'jsus/packager'
 require 'jsus/pool'
 require 'jsus/tree'
 require 'jsus/documenter'
+require 'jsus/validator'
 #
 # Jsus — a library for packaging up your source files.
 #
@@ -34,4 +35,8 @@ module Jsus
   def self.verbose=(verbose)
     @verbose = verbose
   end
+  
+  def self.version
+    @version ||= File.read(File.dirname(__FILE__) + "/../VERSION")
+  end
 end

data/lib/jsus/package.rb

@@ -29,10 +29,14 @@ module Jsus
       Dir.chdir(directory) do
         files.each do |source|
           source_file = SourceFile.from_file(source, :package => self)
-          if source_file.extension?
-            extensions << source_file
+          if source_file
+            if source_file.extension?
+              extensions << source_file
+            else
+              source_files << source_file
+            end
           else
-            source_files << source_file
+            puts "Warning: #{source} is not found for #{name}" if Jsus.verbose?
           end
         end
       end

data/lib/jsus/source_file.rb

@@ -5,6 +5,8 @@
 #
 #
 module Jsus
+  class BadSourceFileException < Exception; end
+  
   class SourceFile
     attr_accessor :relative_filename, :filename, :package # :nodoc:
     # Constructors
@@ -45,12 +47,16 @@ module Jsus
           options[:content]           = source
           new(options)
         else
-#          puts "WARNING: file #{filename} has invalid format (should be YAML)"
-          nil
+          raise BadSourceFileException, "#{filename} is missing a header or header is invalid"
         end
       else
-#        puts "WARNING: file #{filename} does not exist"
-        nil
+        raise BadSourceFileException, "Referenced #{filename} does not exist. #{options[:package] ? "Referenced from package #{options[:package].name}" : ""}"
+      end
+    rescue Exception => e
+      if !e.kind_of?(BadSourceFileException) # if we didn't raise the error; like in YAML, for example
+        raise "Exception #{e.inspect} happened on #{filename}. Please take appropriate measures"
+      else # if we did it, just reraise
+        raise e
       end
     end
 

data/lib/jsus/validator.rb

@@ -0,0 +1,2 @@
+require 'jsus/validator/base'
+require 'jsus/validator/mooforge'

data/lib/jsus/validator/base.rb

@@ -0,0 +1,38 @@
+module Jsus
+  module Validator      
+    class Base
+      def initialize(pool_or_array_or_container)
+        self.source_files = pool_or_array_or_container
+      end
+    
+      def source_files
+        @source_files ||= []
+      end
+      alias_method :sources, :source_files
+    
+      def source_files=(pool_or_array_or_container)
+        case pool_or_array_or_container
+        when Pool
+          @source_files = pool_or_array_or_container.sources.to_a
+        when Array
+          @source_files = pool_or_array_or_container
+        when Container
+          @source_files = pool_or_array_or_container.to_a
+        end
+      end
+      alias_method :sources=, :source_files=
+    
+      def validate
+        validation_errors.empty?
+      end
+      
+      def validation_errors
+        []
+      end
+      
+      def self.validate(*args)
+        new(*args).validate
+      end
+    end
+  end
+end

data/lib/jsus/validator/mooforge.rb

@@ -0,0 +1,19 @@
+module Jsus
+  module Validator
+    class Mooforge < Base
+      def validation_errors
+        @validation_errors ||= sources.inject([]) do |result, sf|
+          if !sf.header
+            result << "#{sf.filename} is missing header"
+          elsif !sf.header["authors"]
+            result << "#{sf.filename} is missing authors"
+          elsif !sf.header["license"]
+            result << "#{sf.filename} is missing license"
+          else
+            result
+          end          
+        end
+      end
+    end
+  end
+end

data/spec/data/MooforgeValidation/README

@@ -0,0 +1,2 @@
+SUMMARY:
+  A basic example of failing mooforge validator

data/spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoAuthors.js

@@ -0,0 +1,13 @@
+/*
+---
+ 
+script: InvalidNoAuthors.js
+ 
+description: A library to work with colors. It has only license but no authors.
+ 
+license: MIT-style license
+ 
+provides: [Color]
+ 
+...
+*/

data/spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoLicense.js

@@ -0,0 +1,13 @@
+/*
+---
+ 
+script: InvalidNoLicense.js
+ 
+description: A library to work with colors. It has only authors, but no license.
+ 
+authors: [Valerio Proietti]
+ 
+provides: [Color]
+ 
+...
+*/

data/spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/Valid.js

@@ -0,0 +1,16 @@
+/*
+---
+ 
+script: Valid.js
+ 
+description: A library to work with colors. It has both license and authors.
+ 
+license: MIT-style license
+ 
+authors:
+- Valerio Proietti
+ 
+provides: [Color]
+ 
+...
+*/

data/spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Widget/Input/Input.Color.js

@@ -0,0 +1,20 @@
+/*
+---
+ 
+script: Input.Color.js
+ 
+description: Cool colorpicker for everyone to enjoy
+ 
+license: MIT-style license
+ 
+authors:
+- Yaroslaff Fedin
+ 
+requires:
+- Input
+- Color
+ 
+provides: [Input.Color]
+ 
+...
+*/

data/spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Widget/Input/Input.js

@@ -0,0 +1,19 @@
+/*
+---
+ 
+script: Input.js
+ 
+description: Basic input class
+ 
+license: MIT-style license
+ 
+authors:
+- Yaroslaff Fedin
+ 
+requires:
+- Widget
+ 
+provides: [Input]
+ 
+...
+*/

data/spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Widget/Widget.js

@@ -0,0 +1,16 @@
+/*
+---
+ 
+script: Widget.js
+ 
+description: An abstract class for all your widgets out there.
+ 
+license: MIT-style license
+ 
+authors:
+- Yaroslaff Fedin
+  
+provides: [Widget]
+ 
+...
+*/

data/spec/data/MooforgeValidation/app/javascripts/Orwik/package.yml

@@ -0,0 +1,11 @@
+name: Orwik
+filename: orwik.js
+web: http://orwik.com
+description: Orwik widgets and essensial things
+license: MIT-Style License, http://mootools.net/license
+copyright: 2008-2010 Yaroslaff Fedin http://orwik.com/people/inviz
+authors: Orwik team, http://developers.orwik.com
+sources:
+  - "Source/Library/Valid.js"
+  - "Source/Library/InvalidNoAuthors.js"
+  - "Source/Library/InvalidNoLicense.js"

data/spec/jsus/source_file_spec.rb

@@ -23,17 +23,24 @@ describe Jsus::SourceFile do
       end
 
       context "when format is invalid" do
-        it "should return nil" do
-          Jsus::SourceFile.from_file('spec/data/bad_test_source_one.js').should == nil
-          Jsus::SourceFile.from_file('spec/data/bad_test_source_two.js').should == nil
+        it "should raise error" do
+          lambda { Jsus::SourceFile.from_file('spec/data/bad_test_source_one.js') }.should raise_error
+          lambda { Jsus::SourceFile.from_file('spec/data/bad_test_source_two.js') }.should raise_error
         end
       end
 
       context "when file does not exist" do
-        it "should return nil" do
-          Jsus::SourceFile.from_file('spec/data/non-existant-file.js').should == nil
+        it "should raise error" do
+          lambda { Jsus::SourceFile.from_file('spec/data/non-existant-file.js') }.should raise_error
         end
       end
+      
+      context "when some error happens" do
+        it "should raise error" do
+          YAML.stub!(:load) { raise "Could not parse the file!" }
+          lambda { subject }.should raise_error(RuntimeError, /spec\/data\/test_source_one\.js/)
+        end        
+      end
     end
 
     it "should set all available fields from constructor" do

data/spec/jsus/validator/base_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Jsus::Validator::Base do
+  subject { described_class.new(pool) }
+  let(:input_dir) { "spec/data/ChainDependencies/app/javascripts" }
+  let!(:pool) { Jsus::Pool.new(input_dir) }
+  context "initialization" do
+    it "should accept pool as the first argument" do
+      described_class.new(pool).source_files.should =~ pool.sources.to_a
+    end
+    
+    it "should accept container as the first argument" do
+      described_class.new(pool.sources).source_files.should =~ pool.sources.to_a
+    end    
+    
+    it "should accept array as the first argument" do
+      described_class.new(pool.sources.to_a).source_files.should =~ pool.sources.to_a
+    end
+  end
+
+  it "should respond to #validate method" do
+    subject.should respond_to(:validate)
+  end
+  
+  describe ".validate" do
+    it "should be the same as calling new + validate" do
+      validator = mock
+      described_class.should_receive(:new).with([1]).and_return(validator)
+      validator.should_receive(:validate).and_return(true)
+      described_class.validate([1])
+    end
+  end
+end

data/spec/jsus/validator/mooforge_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Jsus::Validator::Mooforge do
+  describe "#validate" do
+    let(:input_dir) { "spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library" }
+    let!(:sources) {
+      ["Valid.js", "InvalidNoAuthors.js", "InvalidNoLicense.js"].map {|fn| Jsus::SourceFile.from_file("#{input_dir}/#{fn}") }
+    }
+
+    it "should return true for valid files" do
+      described_class.validate([sources[0]]).should be_true
+      described_class.new([sources[0]]).validation_errors.should == []
+    end
+    
+    it "should return false for files without authors" do
+      described_class.validate([sources[1]]).should be_false
+      described_class.new([sources[1]]).validation_errors[0].should include(sources[1].filename)
+    end
+    
+    it "should return false for files without license" do
+      described_class.validate([sources[2]]).should be_false
+      described_class.new([sources[2]]).validation_errors[0].should include(sources[2].filename)
+    end    
+        
+    it "should return false when some of the files fail" do
+      described_class.validate(sources).should be_false
+      described_class.new(sources).validation_errors.size.should == 2      
+    end    
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 22
-  version: 0.1.22
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Mark Abramov
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-28 00:00:00 +03:00
+date: 2011-01-15 00:00:00 +03:00
 default_executable: jsus
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -121,58 +121,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  prerelease: false
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: json_pure
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  prerelease: false
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: rgl
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  prerelease: false
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: choice
-  requirement: &id012 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  prerelease: false
-  version_requirements: *id012
 description: Javascript packager and dependency resolver
 email: markizko@gmail.com
 executables: 
@@ -206,6 +154,9 @@ files:
 - lib/jsus/source_file.rb
 - lib/jsus/tag.rb
 - lib/jsus/tree.rb
+- lib/jsus/validator.rb
+- lib/jsus/validator/base.rb
+- lib/jsus/validator/mooforge.rb
 - markup/index_template.haml
 - markup/stylesheet.css
 - markup/template.haml
@@ -250,6 +201,14 @@ files:
 - spec/data/JsonPackage/Source/SheetParser.CSS.js
 - spec/data/JsonPackage/Source/sg-regex-tools.js
 - spec/data/JsonPackage/package.json
+- spec/data/MooforgeValidation/README
+- spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoAuthors.js
+- spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/InvalidNoLicense.js
+- spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Library/Valid.js
+- spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Widget/Input/Input.Color.js
+- spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Widget/Input/Input.js
+- spec/data/MooforgeValidation/app/javascripts/Orwik/Source/Widget/Widget.js
+- spec/data/MooforgeValidation/app/javascripts/Orwik/package.yml
 - spec/data/OutsideDependencies/README
 - spec/data/OutsideDependencies/app/javascripts/Core/Source/Class/Class.Extras.js
 - spec/data/OutsideDependencies/app/javascripts/Core/Source/Class/Class.js
@@ -271,6 +230,8 @@ files:
 - spec/jsus/source_file_spec.rb
 - spec/jsus/tag_spec.rb
 - spec/jsus/tree_spec.rb
+- spec/jsus/validator/base_spec.rb
+- spec/jsus/validator/mooforge_spec.rb
 - spec/shared/class_stubs.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -287,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4097730544350789201
+      hash: -2818897829593218981
       segments: 
       - 0
       version: "0"
@@ -315,5 +276,7 @@ test_files:
 - spec/jsus/source_file_spec.rb
 - spec/jsus/tag_spec.rb
 - spec/jsus/tree_spec.rb
+- spec/jsus/validator/base_spec.rb
+- spec/jsus/validator/mooforge_spec.rb
 - spec/shared/class_stubs.rb
 - spec/spec_helper.rb