hoopla_salesforce 0.0.4 → 0.0.5

data/README.md

@@ -1,7 +1,7 @@
 hoopla_salesforce
 =================
 
-A nitfy bundle of dev and deployment tools for working on the (Sales)force.com platform.
+A nifty bundle of dev and deployment tools for working on the (Sales)force.com platform.
 
 Features
 ========
@@ -14,7 +14,7 @@ Features
 6. Undeploys your project (destructiveChanges.xml is auto-generated)
 7. Pre-processes any VisualForce or Apex files with ERB
 8. Generates static test pages from VisualForce pages
-9. Runs tests via the Web UI (as results often differ from deploy tests)
+9. Runs tests via the Web UI (as results often differ from deploy tests) [experimental]
 10. Makes pancakes (pending)
 
 Usage
@@ -35,18 +35,18 @@ Just run:
 
 This will create an folder called myproject that looks like this:
 
-    - myproject 
-    |- Rakefile
-    |- lib/
-    \- src/
-     |- applications/
-     |- classes/
-     |- objects/
-     |- pages/
-     |- resources/
-     |- tabs/
-     |- triggers/
-     \- package.xml 
+    myproject/
+    ├── lib
+    ├── Rakefile
+    └── src
+        ├── applications
+        ├── classes
+        ├── objects
+        ├── package.xml
+        ├── pages
+        ├── resources
+        ├── tabs
+        └── triggers
 
 Once this is done, drop the enterprise.xml and metadata.xml for your org into `lib/` and update the `Rakefile` to reflect your username, password and security token. Now your project is ready to deploy. Run `rake -T` to show the available rake tasks.
 
@@ -65,7 +65,7 @@ During deployment, we'll generate any missing meta.xml files for your assets. Th
 Autopackaging of static resources
 ---------------------------------
 
-As part of deployment, any folders in src/resources will get zipped up as static resources. So for example if you had a folder `src/resources/Performance` the contents of this folder will get zipped into `src/static/resources/Performance.resource`. This makes dealing with zipped CSS/JavaScript much easier.
+As part of deployment, any folders in src/resources will get zipped up as static resources. So for example if you had a folder `src/resources/Performance` the contents of this folder will get zipped into `src/staticresources/Performance.resource`. This makes dealing with zipped CSS/JavaScript much easier.
 
 Undeploying your project
 ------------------------
@@ -79,9 +79,9 @@ Pre-processing with ERB
 
 If you append `.erb` to any file in your project, it will get processed through Erubis prior to deployment. This makes it possible to DRY up a lot of your XML, abstract common patterns and even write simple Apex macros.
 
-Just before the templates are run, the deployer will look for `lib/template_helper.rb` and load that. In this file you can mix your own methods into the template processors. The following example allows you to use `<%= name 'MyObject' %>` in an object definition to avoid writing the XML boilerplate that's required by salesforce.
+Just before the templates are run, the deployer will look for `lib/template_helper.rb` and load that. In this file you can mix your own methods into the template processors. The following example allows you to use `<%= object do %>...<% end %>` in an object file to avoid writing the XML boilerplate that's required by salesforce.
 
-    module GenericHelper
+    class HooplaSalesforce::TemplateProcessor::Generic
       def object(&block)
         code = <<-XML.margin
           <?xml version="1.0" encoding="UTF-8"?>
@@ -93,22 +93,27 @@ Just before the templates are run, the deployer will look for `lib/template_help
         XML
       end
     end
-    HooplaSalesforce::TemplateProcessor::Generic.send(:include, GenericHelper)
 
-Note that you must currently mix your module into the processors at the bottom of the file. The currently available processors are:
+The currently available processors are:
 
 * `HooplaSalesforce::TemplateProcessor::VisualForce` - used for processing page files
 * `HooplaSalesforce::TemplateProcessor::TestPage` - used for generating static test pages
 * `HooplaSalesforce::TemplateProcessor::Generic` - used for any other files
 
+We'll probably start packaging a large set of default helpers with the gem once we have enough projects to demonstrate which helpers should be considered core. If you have recommendations feel free to contact us.
+
 Generating Static Test Pages
 ----------------------------
 
-(documentation pending)
+We can also generate static test pages from your Visual Force pages by using:
+
+    rake hsf:testpages
+
+This makes a `src/pages-test` folder which contains HTML versions of your VisualForce pages. We find this a useful way to do styling and client-side testing. At the moment we only support a few helpers which can generate equivalent VisualForce and HTML, but you can use the template helper technique from the previous section to make more for yourself. The currently implemented helpers are in (template_processor.rb)[http://github.com/hoopla/hoopla_salesforce/blob/master/lib/hoopla_salesforce/template_processor.rb].
 
 Running tests
 -------------
 
 Use WEB_TEST=true to run via web ui. Default will run during deployment. Use TEST_NAMES=Test1,Test2,etc to run specific tests (or TEST_NAMES="" to skip tests).
 
-(more documentation pending)
+(more documentation pending, this feature is still experimental)

data/lib/hoopla_salesforce/deployer.rb

@@ -7,6 +7,8 @@ Savon::Request.logger.level = Logger::WARN
 Savon::Request.log_level = :debug
 
 module HooplaSalesforce
+  # Deploys and retreives zip files from salesforce using the metadata API.
+  # Use ENV['LOGIN_HOST'] = 'test.salesforce.com' to use this on sandbox organizations.
   class Deployer
     attr_accessor :client, :metaclient, :header,
                   :username, :password, :token
@@ -31,11 +33,13 @@ module HooplaSalesforce
     end
 
     def set_certs
-      # TODO figure out how to get Savon to validat SF's cert
+      # TODO figure out how to get Savon to validate SF's cert
       [@client, @metaclient].each { |c| c.request.http.ssl_client_auth(:verify_mode => OpenSSL::SSL::VERIFY_NONE) }
     end
 
     def setup_metaclient_and_store_header
+      client.wsdl.soap_endpoint.host = ENV['LOGIN_HOST'] if ENV['LOGIN_HOST']
+
       response = client.login do |soap, wsse|
         soap.body = { "wsdl:username" => username, "wsdl:password" => password + token}
       end.to_hash[:login_response][:result]
@@ -60,10 +64,13 @@ module HooplaSalesforce
    
       puts "Deployment requested, awaiting completion of job #{response[:id]}..." 
       while !response[:done]
-        response = metaclient.check_status do |soap, wsse|
-          soap.header = header
-          soap.body = { "wsdl:asyncProcessId" => response[:id] }
-        end.to_hash[:check_status_response][:result]
+        begin
+          response = metaclient.check_status do |soap, wsse|
+            soap.header = header
+            soap.body = { "wsdl:asyncProcessId" => response[:id] }
+          end.to_hash[:check_status_response][:result]
+        rescue Timeout::Error
+        end
       end 
 
       response = metaclient.check_deploy_status do |soap, wsse|

data/lib/hoopla_salesforce/info.rb

@@ -13,7 +13,7 @@ module HooplaSalesforce
     end
 
     def version
-      "0.0.4"
+      "0.0.5"
     end
   end
 end

data/lib/hoopla_salesforce/rake/deploy_task.rb

@@ -86,11 +86,13 @@ module HooplaSalesforce
             end
           end
 
-          desc "Renders any page templates as test pages in #{processed_src}/pages-test"
-          task :testpages => dependencies do
-            mkdir_p "#{src}/pages-test"
-            make_pages do |template|
-              HooplaSalesforce::TemplateProcessor::TestPage.new(src, template)
+          namespace :testpages do
+            desc "Renders any page templates as test pages in #{processed_src}/pages-test"
+            task task_name => dependencies do
+              mkdir_p "#{src}/pages-test"
+              make_pages do |template|
+                HooplaSalesforce::TemplateProcessor::TestPage.new(src, template)
+              end
             end
           end
         end
@@ -112,11 +114,9 @@ module HooplaSalesforce
       end
 
       def test_options
-        if test_names.empty?
-          { "wsdl:runAllTests" => true }
-        else
+        unless test_names.empty?
           test_names.map! { |n| "#{clean_namespace}.#{n}" } if package_namespace
-          { "wsdl:runTests" => testNames }
+          { "wsdl:runTests" => test_names }
         end
       end
 
@@ -260,9 +260,7 @@ module HooplaSalesforce
         end
       end
 
-      def process_source
-        rm_rf processed_src
-        cp_r src, processed_src
+      def substitute_namespaces
         Dir["#{processed_src}/**/*"].each do |f|
           next if File.directory?(f)
           system %Q|ruby -i -n -e 'print $_.gsub("__NAMESPACE__", "#{package_namespace}")' "#{f}"|
@@ -271,7 +269,11 @@ module HooplaSalesforce
         if package_namespace
           system %Q|ruby -i -n -e 'print $_.gsub("#{package_namespace}", "#{clean_namespace}")' "#{processed_src}/package.xml"|
         end
+      end
 
+      def process_source
+        rm_rf processed_src
+        cp_r src, processed_src
         make_resources
         make_pages do |template|
           HooplaSalesforce::TemplateProcessor::VisualForce.new(processed_src, template)
@@ -282,6 +284,8 @@ module HooplaSalesforce
           HooplaSalesforce::TemplateProcessor::Generic.new(processed_src, template)
           rm template
         end
+
+        substitute_namespaces
       end
     end
   end

data/lib/hoopla_salesforce/rake/retrieve_task.rb

@@ -4,12 +4,17 @@ module HooplaSalesforce
   module Rake
     class RetrieveTask < BaseTask
       # The format of the retrieve request. Defaults to:
-      #   { "wsdl:unpackaged" => { "wsdl:types" =>
-      #     [{ "wsdl:members" => "*", "wsdl:name" => "ApexClass" }]
-      #   }}
+      #   { "wsdl:apiVersion" => "18.0",
+      #     "wsdl:unpackaged" => { "wsdl:types" =>
+      #       [{ "wsdl:members" => "*", "wsdl:name" => "ApexClass" }]
+      #     }
+      #   }
       #
       # If your code is in a salesforce package, you can specify:
       #   { "wsdl:packageNames" => ["Your Package Name"] }
+      #
+      # NOTE: Some components will only be available in higher API versions, so
+      #       make sure to set your apiVersion accordingly.
       attr_accessor :request
 
       def initialize(name=:retrieve)

data/lib/hoopla_salesforce/skeleton.rb

@@ -86,13 +86,11 @@ module HooplaSalesforce
           HooplaSalesforce.enterprise_wsdl = "lib/enterprise.xml"
           HooplaSalesforce.metadata_wsdl   = "lib/metadata.xml"
           
-          namespace :deploy do
-            HooplaSalesforce::Rake::DeployTask.new(:development) do |t|
-              t.username  = "you@development.org"
-              t.password  = "yourpassword"
-              t.token     = "your security token"
-              t.namespace = "" 
-            end
+          HooplaSalesforce::Rake::DeployTask.new(:development) do |t|
+            t.username  = "you@development.org"
+            t.password  = "yourpassword"
+            t.token     = "your security token"
+            t.namespace = "" 
           end
         EOS
       end

data/lib/hoopla_salesforce/template_processor.rb

@@ -19,6 +19,7 @@ module HooplaSalesforce
 
       def each_resource_file(files, extension)
         files.map do |file|
+          # FIXME, this added .js on a .js file
           file += ".#{extension}" unless extension =~ /\.#{extension}$/
           yield file
         end.join("\n")

data/lib/hoopla_salesforce/utils.rb

@@ -1,7 +1,7 @@
 module HooplaSalesforce
   module Utils
     def extract_class_name(body)
-      (match = body.match(/\bclass\s+(\w+)\s*\{\s*/)) && match[1]
+      (match = body.match(/\bclass\s+(\w+)/)) && match[1]
     end
 
     def extract_trigger_name(body)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Trotter Cashion
@@ -15,13 +15,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-27 00:00:00 -04:00
+date: 2010-10-31 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoopla-savon
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -36,6 +37,7 @@ dependencies:
   name: rubyzip
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -50,6 +52,7 @@ dependencies:
   name: commander
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -64,6 +67,7 @@ dependencies:
   name: erubis
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -78,6 +82,7 @@ dependencies:
   name: mechanize
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -99,22 +104,22 @@ extra_rdoc_files: []
 files: 
 - README.md
 - bin/hoopla_salesforce
-- lib/hoopla_salesforce/rake.rb
+- lib/hoopla_salesforce/commands.rb
+- lib/hoopla_salesforce/deployer.rb
+- lib/hoopla_salesforce/eruby.rb
+- lib/hoopla_salesforce/ext/commander.rb
+- lib/hoopla_salesforce/ext/string.rb
+- lib/hoopla_salesforce/info.rb
+- lib/hoopla_salesforce/package_generator.rb
 - lib/hoopla_salesforce/rake/base_task.rb
 - lib/hoopla_salesforce/rake/deploy_task.rb
 - lib/hoopla_salesforce/rake/retrieve_task.rb
-- lib/hoopla_salesforce/eruby.rb
-- lib/hoopla_salesforce/web_agent.rb
-- lib/hoopla_salesforce/utils.rb
-- lib/hoopla_salesforce/text_reporter.rb
+- lib/hoopla_salesforce/rake.rb
 - lib/hoopla_salesforce/skeleton.rb
 - lib/hoopla_salesforce/template_processor.rb
-- lib/hoopla_salesforce/package_generator.rb
-- lib/hoopla_salesforce/commands.rb
-- lib/hoopla_salesforce/info.rb
-- lib/hoopla_salesforce/ext/string.rb
-- lib/hoopla_salesforce/ext/commander.rb
-- lib/hoopla_salesforce/deployer.rb
+- lib/hoopla_salesforce/text_reporter.rb
+- lib/hoopla_salesforce/utils.rb
+- lib/hoopla_salesforce/web_agent.rb
 - lib/hoopla_salesforce.rb
 has_rdoc: true
 homepage: http://hoopla.net
@@ -126,6 +131,7 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -133,6 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -142,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: nowarning
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Helpers for building Salesforce.com projects