flex-sdk 0.3.1 → 0.3.2

data/README.markdown

@@ -1,45 +1,76 @@
 # flex-sdk
 
-Provides the FlexSDK for building the Flex applications
+Provides a Gemified wrapper for the FlexSDK, for building Flex applications in other projects.
+
+Note: This Gem does not provide or redistribute the actual Flex SDK, only a way to download it and build against it in other projects.
 
 ## Installation
 
-This gem is (or at least should be) included in a Gemfile for the project.
+This gem is (or at least should be) included in a Gemfile for the project that requires the Flex SDK.
 
-The Gemfile should have a line something like this:
+The Flex Project's Gemfile should have a line something like this:
 
-    gem "flex-sdk", :git => "git://github.com/visfleet/flex-sdk.git"
+    gem "flex-sdk"
     
 It could also probably be put in a "build" group. This would mean that Rails won't attempt to load it during normal operation, only during Rake tasks. Like this:
 
     group :build do
-      gem "flex-sdk", :git => "git://github.com/visfleet/flex-sdk.git"
+      gem "flex-sdk"
     end
     
-## Usage
+## Usage in Ruby
+
+    require 'flex-sdk'
+    ...
+    flexsdk = FlexSDK.new
+    ...
+    config = flexsdk.config
+    ...
+    config["sdk_dir"]
+    => "/Volumes/Data/git/flex-sdk/vendor/flex_sdk_3.5.0.12683"
+
+    flexsdk.download(config)
+    => "Downloading SDK"
+    =>  "From: http://fpdownload.adobe.com/pub/flex/sdk/builds/flex3/flex_sdk_3.5.0.12683.zip"
+    =>  "To: /Volumes/Data/git/flex-sdk/vendor/flex_sdk_3.5.0.12683.zip"
+
+    flexsdk.unzip(config)
+    => "Unzipping SDK"
+    => "From: /Volumes/Data/git/flex-sdk/vendor/flex_sdk_3.5.0.12683.zip"
+    => "To: /Volumes/Data/git/flex-sdk/vendor/flex_sdk_3.5.0.12683/"
+    
+## Usage in Bash
+
+To download and unzip the Flex SDK from Adobe site, into vendor/ in this Gem
+
+  bundle exec flex-sdk-prime
+
+Report the installation path of the Flex SDK
+
+  bundle exec flex-sdk-path
 
-TODO
 
 ## Upgrading the SDK version used in this Gem
 
-Update the SDK version in the Rakefile of this project, e.g
+Edit config.yml and update the version number. Make sure that this is a valid version on the Adobe website. e.g:
 
-    sdk_ver = "3.5.0.12683"
+    sdk_ver: "3.5.0.12683"
+    
 Bump the version of this gem
 
     rake version:bump:minor
+    
 Release
 
     rake release
 
 ## Copylocale
 
-Once the SDK in downloaded, unzipped and copied in, this project (flex-sdk) has a Rake task to do the copylocale thing:
+Once the SDK is downloaded, unzipped and copied in, this project (flex-sdk) has a method to do the copylocale thing:
 
-    rake flex:copy_locale
+    flexsdk.copylocale(config)
     
 In the old money, this is the same as doing:
 
     (Old way) bin/copylocale en_US en_NZ
-    
-Once this is done, make sure you commit / push back to GitHub.
+

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/bin/flex-sdk-prime

@@ -8,4 +8,4 @@ config = flexsdk.config
 
 flexsdk.download(config)
 flexsdk.unzip(config)
-
+puts "Done. Flex SDK should now be ready for building\n\n"

data/flex-sdk.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flex-sdk}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jonathan Hoskin"]

data/lib/flex-sdk.rb

@@ -1,14 +1,17 @@
 class FlexSDK
 
+  # Create a hash of configuration objects, some from config.yml, the rest figured out
   def config
     require 'yaml'
     config = YAML.load_file(File.expand_path(File.join((File.dirname(__FILE__)), "..", "config.yml")))
     config_hash = config["flex-sdk"]
 
+    # These variables are provided by config.yml
     sdk_ver = config_hash["sdk_ver"]
     vendor_path = config_hash["vendor_path"]
     cdn_path = config_hash["cdn_path"]
-  
+    
+    # These variables are determined at runtime and combined into one hash
     sdk_name = "flex_sdk_" + sdk_ver
     config_hash["sdk_name"] = sdk_name
     sdk_file = sdk_name + ".zip"
@@ -18,17 +21,27 @@ class FlexSDK
     config_hash["dest_dir"] = dest_dir
     config_hash["dest_file"] = File.join(dest_dir, sdk_file)
     config_hash["sdk_dir"] = File.join(dest_dir, sdk_name)
+    
     config_hash
   end
   
+  # Return the full path to the SDK dir, so other things/people can use it
   def sdk_dir
     config = self.config
     sdk_dir = config["sdk_dir"]
   end
 
+  # Download the SDK zip file to the gem
   def download(config)
+    require 'fileutils'
+    
+    dest_dir = config["dest_dir"]
     dest_file = config["dest_file"]
     cdn_file = config["cdn_file"]
+    
+    # Make sure the destination dir (likely GEM_NAME/vendor/) exists
+    FileUtils.mkdir_p dest_dir
+    
     puts "\n"
     unless File.file?(dest_file)
       puts "Downloading SDK\n\tFrom:\t#{cdn_file}\n\tTo:\t#{dest_file}\n\n"
@@ -41,15 +54,13 @@ class FlexSDK
     end
   end
 
+  # Unzip the downloaded zip file into the target dir
   def unzip(config)
-    require 'fileutils'
-    
     sdk_dir = config["sdk_dir"]
     dest_file = config["dest_file"]
     dest_dir = config["dest_dir"]
     
     puts "\n"
-    FileUtils.mkdir_p dest_dir
     unless File.directory?(sdk_dir)
       puts "Unzipping SDK\n\tFrom:\t#{dest_file}\n\tTo:\t#{sdk_dir}/\n\n"
       `unzip #{dest_file} -d #{dest_dir}`
@@ -59,9 +70,9 @@ class FlexSDK
     else
       puts "Won't unzip SDK, directory #{sdk_dir}/ already exists\n\n"
     end
-    puts "Done. Flex SDK should now be ready for building\n\n"
   end
 
+  # Perform the copylocale step
   def copylocale(config)
     sdk_name = config["sdk_dir"]
     puts = `#{sdk_dir}/bin/copylocale en_US en_NZ`

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flex-sdk
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Jonathan Hoskin