jstyler 0.0.4

data/lib/jstyler.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Jstyler
+  VERSION = '0.0.4'
+  
+  GEM_DIRECTORY = File.expand_path(File.dirname(__FILE__)+'/../')
+  
+  FORMATTER_LIB = 'formatter-0.0.2.jar'
+  
+  JAVA_LIBS = File.expand_path(File.dirname(__FILE__)+'/../javalibs')
+  
+end
+
+require 'jstyler/beautify'
+require 'jstyler/settings'

data/lib/jstyler/beautify.rb

@@ -0,0 +1,151 @@
+# beautify.rb
+
+require 'buildr'
+require 'session'
+
+module Jstyler
+  
+  module Beautify
+    
+    include Extension
+    
+    class BeautifyRunner
+      
+      include Jstyler
+      
+      def initialize
+        @conventions = ['java', 'eclipse']
+        @allowed_options = ['config', 'convention', 'verbose']
+      end
+      
+      #  :call-seq:
+      #   run = config_file, src/ src2
+      #   run = hash, src (hash - {:config=>config_file, :verbose=>true })
+      def run(config_options, *srcs)
+        @options = { :config=>config_options } unless Hash === config_options
+        @options = config_options if @options == nil
+        current_dir = Dir.pwd
+        
+        #validation
+        result = validate_config_path @options
+        result = validate_source_directory srcs if result
+        result = validate_env if result
+        
+        #prepare call
+        execution_string = ''
+        if result
+          execution_string = flatten_sources srcs
+          execution_string = flatten_options(@options) + execution_string
+          
+          Dir.chdir(JAVA_LIBS)
+          java = File.expand_path ENV['JAVA_HOME']+'/bin/java'
+          cmd = "#{java} -jar #{FORMATTER_LIB} #{execution_string} "
+          shell = Session::Shell.new
+          stdout, stderr = shell.execute cmd
+          status = shell.status 
+          puts stdout
+          puts stderr if !status
+          
+          #change directory to previous one
+          Dir.chdir(current_dir)
+          result = execution_string
+        end
+        
+        result
+      end
+      
+      def flatten_options(options = {})
+        options_string = ''
+        options.each {|key,val|
+          val = File.expand_path val if key.to_s.include? 'config' 
+          options_string += " -#{key}  #{val}"
+        }
+        
+        options_string
+      end
+      
+      def flatten_sources(srcs = [])
+        src_string = ''
+        srcs.uniq.flatten.each {|src| src_string += " " + File.expand_path(src)}
+        
+        src_string
+      end
+      
+      def validate_env
+        if !ENV.has_key?('JAVA_HOME')
+          puts "There is no JAVA_HOME in your environment"
+          return false
+        end
+        return true
+      end
+      private :validate_env
+      
+      def validate_source_directory sources
+        if ! sources.empty? && sources.uniq.flatten.each { |item| return ! item.nil? && File.exist?(item) }
+          puts "Source(s) directory(ies) cannot be accessed"
+          return false
+        end
+        return true
+      end
+      private :validate_source_directory
+      
+      def validate_config_path config_options
+        #validation
+        # use default convention (Java)
+        if ! config_options.has_key?(:config) && ! config_options.has_key?(:convention) 
+          puts "Config path and convention were not defined, will use Java convention."
+          @options[:config] = File.expand_path GEM_DIRECTORY+'/conventions/java.prefs'
+        end
+        # use specified built-in convention
+        if ! config_options.has_key?(:config) && config_options.has_key?(:convention)
+          convention = "#{config_options.fetch(:convention)}".downcase
+          puts "Convention '#{convention}' was defined."
+          @options[:config] = ''
+          @options[:config] = File.expand_path(GEM_DIRECTORY+"/conventions/#{convention}.prefs") if @conventions.include?(convention)
+          @options.delete :convention
+        end
+        if !File.exist? @options.fetch(:config).to_s
+          puts "Config path does not exist"
+          return false
+        end
+        options_to_check = [].concat @options.keys
+        options_to_check.each{|key|
+          @options.delete key if !(@allowed_options.include? key.to_s)
+          @options[key] = '' if key.to_s == 'verbose' #verbose value should be empty
+        }
+        return true
+      end
+      private :validate_config_path
+      
+    end
+    
+    # task not specific to any project
+    first_time do
+      Project.local_task('format') 
+    end
+    
+    before_define do |project|
+      
+    end
+    
+    after_define do |project|
+      
+      task 'format' do |task|
+        puts "Perform formatting...."
+        JAVA_LIBS = File.expand_path project.path_to :target
+        
+        runner = BeautifyRunner.new
+        sources_to_format = [].concat project.compile.sources
+        sources_to_format.concat project.test.compile.sources if ! project.test.compile.sources.empty?
+        runner.run(project.jstyler.options, sources_to_format.flatten)
+      end
+    end
+    
+  end  
+  
+end
+
+#inject beautifier into buildr project
+class Buildr::Project
+  include Jstyler::Beautify  
+end

data/lib/jstyler/settings.rb

@@ -0,0 +1,46 @@
+# settings.rb
+
+module Jstyler
+  
+  class Settings
+    
+    include Singleton
+    include Buildr
+    
+    # :call-seq:
+    #   jstyler => Hash
+    #
+    # Returns an hash of all settings attributes for Jstyler.
+    #
+    # Within application build file you can specify settings for Jstyler in following way:
+    #   jstyler.options = {:config=>'path_to_config'}
+    #
+    # You can also specify configuration options in the build.yaml (within project source directory)
+    # or in the .buildr/settings.yaml in your HOME directory.
+    #
+    # For example:
+    # jstyler:
+    #   options:
+    #     config: path_to_config
+    #     verbose: true
+    def options
+      unless @options_holder
+        @options_holder = Hash.new(Buildr.settings.build).merge({}) { |repos, hash|
+          repos | Hash.new(hash['jstyler'] && hash['jstyler']['options'])
+        }
+      end
+      
+      @options_holder
+    end    
+    
+  end
+  
+end
+
+module Buildr
+  
+  def jstyler
+    return Jstyler::Settings.instance
+  end
+  
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/jstyler.rb'}"
+puts "Loading jstyler gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/beautify_spec.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+include Jstyler
+include Jstyler::Beautify
+include Buildr
+
+describe BeautifyRunner, "when is being ran" do
+  
+  before do
+    @beautify = BeautifyRunner.new
+    @config = File.expand_path GEM_DIRECTORY+'/conventions/java.prefs'
+    @src = File.expand_path File.dirname(__FILE__)+'/fixture'
+  end
+  
+  it "should error if src argument is not defined" do
+    @beautify.run({}, nil).should be_false
+    @beautify.run({}, '').should be_false
+  end
+  
+  it "should use built-in default config if it and convention attributes were not defined" do
+    res = @beautify.run({}, @src)
+    res.should be_true
+    res.should include '-config'
+  end
+  
+  it "should not pass -convention attribute to java" do
+    res = @beautify.run({:convention=>:Java}, @src)
+    res.should be_true
+    res.should include '-config'
+    res.should_not include '-convention'
+  end
+  
+  it "should fail if -convention attribute does not exist" do
+    res = @beautify.run({:convention=>:Java_custom}, @src)
+    res.should be_false
+  end
+  
+  it "should error if config does not exist" do
+    res = @beautify.run({:verbose=>'', :config=>@config+'_'}, @src)
+    res.should be_false
+  end
+  
+  it "should error if src directory is does not exist" do
+    @beautify.run({:config=>"somepath"}, 'nilsrc').should be_false
+    @beautify.run({:config=>"somepath"}, 'nilsrc', 'sbfdgb').should be_false
+  end
+  
+  it "should error if there is no JAVA_HOME environment var" do
+    previous = ENV['JAVA_HOME']
+    ENV.delete('JAVA_HOME')
+    @beautify.run({:config=>@config}, @src).should be_false
+    ENV['JAVA_HOME'] = previous
+  end
+  
+  it "should have flatten to string source arguments" do
+    res = @beautify.run({:config=>@config}, @src, @src)
+    res.should_not be_false
+    res.should include @src
+  end
+  
+  it "should contain prepared command line attributes as a string" do
+    res = @beautify.run({:config=>@config, :verbose=>''}, @src)
+    res.should be_true
+    res.should include "-config"
+    res.should include @config
+    res.should include "-verbose"
+  end
+  
+  it "should prevent passing not supported configuration options" do
+    res = @beautify.run({:config=>@config, :verbose=>'true', :someother_property=>'someother_property', :some=>''}, @src)
+    res.should be_true
+    res.should_not include '-someother_property'
+    res.should_not include '-some'
+    res.should include 'config'
+    res.should include 'verbose'
+  end
+  
+end

data/spec/fixture/name/webdizz/styler/fixture/FormatterFixture.java

@@ -0,0 +1,14 @@
+/**
+ * 
+ */
+package name.webdizz.styler.fixture;
+
+/**
+ * @author webdizz
+ * 
+ */
+public class FormatterFixture {
+
+    private static final String CONSTANT = "";
+
+}

data/spec/jstyler_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    # violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+
+require 'jstyler'
+require 'jstyler/beautify'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: jstyler
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- webdizz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-03 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: buildr
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 3
+        - 5
+        version: 1.3.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: session
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id004
+description: |-
+  This is an extension for BuildR to provide abilities to format Java source code according to conventions.
+  This extension uses built-in Eclipse functionality to format code, but without requirements to have installed Eclipse.
+email: 
+- webdizz@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- EPL-LICENSE
+- History.txt
+- MIT-LICENSE
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- TODO
+- conventions/eclipse.prefs
+- conventions/java.prefs
+- javalibs/common-3.5.1.r35x_v20090807.jar
+- javalibs/equinox.app-1.2.1.R35x_v20091203.jar
+- javalibs/formatter-0.0.2.jar
+- javalibs/jdt.core-3.6.0-customized.jar
+- javalibs/jobs-3.4.100.v20090429.jar
+- javalibs/osgi-3.5.2.R35x_v20100126.jar
+- javalibs/resources-3.5.2.r35x_v20091203.jar
+- javalibs/text-3.5.0.v20090513.jar
+- lib/jstyler.rb
+- lib/jstyler/beautify.rb
+- lib/jstyler/settings.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/beautify_spec.rb
+- spec/fixture/name/webdizz/styler/fixture/FormatterFixture.java
+- spec/jstyler_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://webdizz.name/posts/jstyler
+licenses: []
+
+post_install_message: "\n  Usage: \n     buildr format \n  For details go to http://webdizz.name/posts/jstyler.\n  "
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: jstyler
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This is an extension for BuildR to provide abilities to format Java source code according to conventions
+test_files: []
+