jrsplenda 0.1.0

data/spec/field_helper_spec.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+import 'fixtures.PrivateField'
+import 'fixtures.ProtectedField'
+import 'fixtures.PackageField'
+
+describe "A field helper" do
+  include JRSplenda::FieldHelper
+  
+  describe "for a private field" do
+    before(:each) do
+      @f = PrivateField.new
+      wrap_java_fields @f
+    end
+    
+    it "should provide an attr set method" do
+      lambda { @f.str_field = "42" }.should_not raise_error
+    end
+    
+    it "should not provide an attr set method if the field is final" do
+      lambda { @f.final_field == "42" }.should raise_error
+    end
+  end
+  
+  describe "for a protected field" do
+    before(:each) do
+      @f = ProtectedField.new
+      wrap_java_fields @f
+    end
+        
+    it "should provide an attr set method" do
+      lambda { @f.str_field = "42" }.should_not raise_error
+    end
+    
+    it "should not provide an attr set method if the field is final" do
+      lambda { @f.final_field == "42" }.should raise_error
+    end
+  end
+  
+  describe "for a package-scoped field" do
+    before(:each) do
+      @f = PackageField.new
+      wrap_java_fields @f      
+    end
+    
+    it "should provide an attr set method" do
+      lambda { @f.str_field = "42" }.should_not raise_error
+    end
+    
+    it "should not provide an attr set method if the field is final" do
+      lambda { @f.final_field == "42" }.should raise_error
+    end
+  end
+  
+  describe "for a static private field" do
+    before(:all) do
+      wrap_java_fields PrivateField
+    end
+    
+    it "should provide an attr set method" do
+      lambda { PrivateField.static_field = "42" }.should_not raise_error
+    end
+    
+    it "should not provide an attr set method if the field is final" do
+      lambda { PrivateField.static_final_field == "42" }.should raise_error
+    end
+  end
+  
+  describe "for a static protected field" do
+    before(:all) do
+      wrap_java_fields ProtectedField
+    end
+        
+    it "should provide an attr set method" do
+      lambda { ProtectedField.static_field = "42" }.should_not raise_error
+    end
+    
+    it "should not provide an attr set method if the field is final" do
+      lambda { ProtectedField.static_final_field == "42" }.should raise_error
+    end
+  end
+  
+  describe "for a static package-scoped field" do
+    before(:all) do
+      wrap_java_fields PackageField
+    end
+    
+    it "should provide an attr set method" do
+      lambda { PackageField.static_field = "42" }.should_not raise_error
+    end
+    
+    it "should not provide an attr set method if the field is final" do
+      lambda { PackageField.static_final_field == "42" }.should raise_error
+    end
+  end  
+end

data/spec/fixtures/PackageField.java

@@ -0,0 +1,12 @@
+package fixtures;
+
+public class PackageField {
+  String strField = "42";
+  final String finalField = "foo";  
+  static String staticField = "42";
+  static final String staticFinalField = "42";
+  
+  public String getStrField() {
+    return strField;
+  }
+}

data/spec/fixtures/PackageInstanceMethod.java

@@ -0,0 +1,7 @@
+package fixtures;
+
+public class PackageInstanceMethod {
+  String thePackageScopeMethod() {
+    return "42";
+  }
+}

data/spec/fixtures/PackageStaticMethod.java

@@ -0,0 +1,7 @@
+package fixtures;
+
+public class PackageStaticMethod {
+  static String thePackageScopeMethod() {
+    return "42";
+  }
+}

data/spec/fixtures/PrivateField.java

@@ -0,0 +1,12 @@
+package fixtures;
+
+public class PrivateField {
+  private String strField = "42";
+  private final String finalField = "foo";
+  private static String staticField = "42";
+  private static final String staticFinalField = "42";  
+  
+  public String getStrField() {
+    return strField;
+  }
+}

data/spec/fixtures/PrivateInstanceMethod.java

@@ -0,0 +1,7 @@
+package fixtures;
+
+public class PrivateInstanceMethod {
+  private String thePrivateMethod() {
+    return "42";
+  }
+}

data/spec/fixtures/PrivateStaticMethod.java

@@ -0,0 +1,7 @@
+package fixtures;
+
+public class PrivateStaticMethod {
+  public static String thePrivateMethod() {
+    return "42";
+  }
+}

data/spec/fixtures/ProtectedField.java

@@ -0,0 +1,12 @@
+package fixtures;
+
+public class ProtectedField {
+  protected String strField = "42";
+  protected final String finalField = "foo";  
+  protected static String staticField = "42";
+  protected static final String staticFinalField = "42";
+  
+  public String getStrField() {
+    return strField;
+  }
+}

data/spec/fixtures/ProtectedInstanceMethod.java

@@ -0,0 +1,7 @@
+package fixtures;
+
+public class ProtectedInstanceMethod {
+  protected String theProtectedMethod() {
+    return "42";
+  }
+}

data/spec/fixtures/ProtectedStaticMethod.java

@@ -0,0 +1,7 @@
+package fixtures;
+
+public class ProtectedStaticMethod {
+  protected static String theProtectedMethod() {
+    return "42";
+  }
+}

data/spec/fixtures/PublicField.java

@@ -0,0 +1,9 @@
+package fixtures;
+
+public class PublicField {
+  public String strField;
+  
+  public String getStrField() {
+    return strField;
+  }
+}

data/spec/method_helper_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+import 'fixtures.PrivateInstanceMethod'
+import 'fixtures.PrivateStaticMethod'
+import 'fixtures.ProtectedInstanceMethod'
+import 'fixtures.ProtectedStaticMethod'
+import 'fixtures.PackageInstanceMethod'
+import 'fixtures.PackageStaticMethod'
+
+describe "A method helper" do
+  include JRSplenda::MethodHelper
+  
+  it "should provide the ability to invoke private Java class methods" do
+    wrap_java_methods PrivateStaticMethod
+    lambda { PrivateStaticMethod.thePrivateMethod }.should_not raise_error
+  end
+  
+  it "should provide the ability to invoke protected Java class methods" do
+    wrap_java_methods ProtectedStaticMethod
+    lambda { ProtectedStaticMethod.theProtectedMethod }.should_not raise_error
+  end
+  
+  it "should provide the ability to invoke package scope Java class methods" do
+    wrap_java_methods PackageStaticMethod
+    lambda { PackageStaticMethod.thePackageScopeMethod }.should_not raise_error
+  end
+  
+  it "should provide the ability to invoke private Java instance methods" do
+    o = PrivateInstanceMethod.new
+    wrap_java_methods o
+    lambda { o.thePrivateMethod }.should_not raise_error
+  end
+  
+  it "should provide the ability to invoke protected Java instance methods" do
+    o = ProtectedInstanceMethod.new
+    wrap_java_methods o
+    lambda { o.theProtectedMethod }.should_not raise_error
+  end
+  
+  it "should provide the ability to invoke package scope Java instance methods" do
+    o = PackageInstanceMethod.new
+    wrap_java_methods o
+    lambda { o.thePackageScopeMethod }.should_not raise_error
+  end
+end

data/spec/mock_helper_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "A mock helper" do
+  include JRSplenda::MockHelper
+  
+  it "should create a mock of a Java class when give a Java class name when the Java class has not been imported" do
+    splenda_mock('fixtures.PrivateField').class.name.should include("Mock")
+  end
+
+  it "should create a mock of a Java class when give a Java class name when the Java class has been imported" do
+    splenda_mock('fixtures.PrivateField').class.name.should include("Mock")
+  end
+  
+  it "should create a mock of a Java class when given a Ruby class wrapping the Java class" do
+    import 'fixtures.PrivateField'
+    splenda_mock(PrivateField).class.name.should include("Mock")
+  end
+  
+  it "should create a mock of a Java class when given a Java class" do
+    import 'fixtures.PrivateField'
+    splenda_mock(PrivateField.java_class).class.name.should include("Mock")
+  end  
+  
+  describe "when creating a mock object" do
+    it "should optionally store the created mock in a Ruby member variable by convention" do
+      splenda_mock_attr('fixtures.PrivateField')
+      @private_field.should_not be_nil
+    end
+    
+    it "should optionally store the created mock in a Ruby member variable specified by the caller" do
+      splenda_mock_attr('fixtures.PrivateField', :store_in => :another_field)
+      @another_field.should_not be_nil
+    end
+    
+    it "should optionally not overwrite existing member variables" do
+      splenda_mock_attr('fixtures.PrivateField')
+      p1 = @private_field
+      splenda_mock_attr('fixtures.PrivateField', :preserve_existing_attr => true)
+      p1.should == @private_field
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + "/../lib/jrsplenda.rb"
+
+require File.dirname(__FILE__) + "/../build/jrsplenda-fixtures.jar"
+
+include Java

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/website/index.html

@@ -0,0 +1,11 @@
+<html>
+	<head>
+		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
+		<title>jrsplenda</title>
+		
+	</head>
+	<body id="body">
+		<p>This page has not yet been created for RubyGem <code>jrsplenda</code></p>
+		<p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
+	</body>
+</html>

data/website/index.txt

@@ -0,0 +1,83 @@
+h1. jrsplenda
+
+h1. → 'jrsplenda'
+
+
+h2. What
+
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install jrsplenda</pre>
+
+h2. The basics
+
+
+h2. Demonstration of usage
+
+
+
+h2. Forum
+
+"http://groups.google.com/group/jrsplenda":http://groups.google.com/group/jrsplenda
+
+TODO - create Google Group - jrsplenda
+
+h2. How to submit patches
+
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+
+TODO - pick SVN or Git instructions
+
+The trunk repository is <code>svn://rubyforge.org/var/svn/jrsplenda/trunk</code> for anonymous access.
+
+OOOORRRR
+
+You can fetch the source from either:
+
+<% if rubyforge_project_id %>
+
+* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>
+
+<pre>git clone git://rubyforge.org/jrsplenda.git</pre>
+
+<% else %>
+
+* rubyforge: MISSING IN ACTION
+
+TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
+yet to refresh your local rubyforge data with this projects' id information.
+
+When you do this, this message will magically disappear!
+
+Or you can hack website/index.txt and make it all go away!!
+
+<% end %>
+
+* github: "http://github.com/GITHUB_USERNAME/jrsplenda/tree/master":http://github.com/GITHUB_USERNAME/jrsplenda/tree/master
+
+<pre>git clone git://github.com/GITHUB_USERNAME/jrsplenda.git</pre>
+
+
+TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.
+
+
+* gitorious: "git://gitorious.org/jrsplenda/mainline.git":git://gitorious.org/jrsplenda/mainline.git
+
+<pre>git clone git://gitorious.org/jrsplenda/mainline.git</pre>
+
+h3. Build and test instructions
+
+<pre>cd jrsplenda
+rake test
+rake install_gem</pre>
+
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Comments are welcome. Send an email to "FIXME full name":mailto:FIXME email via the "forum":http://groups.google.com/group/jrsplenda
+