geoffrey 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
 *.gem
 .bundle
+.yardoc
+doc

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    geoffrey (0.0.0)
+    geoffrey (0.0.2)
       plist4r
 
 GEM
   remote: http://rubygems.org/
   specs:
-    awesome_print (0.2.1)
+    bluecloth (2.0.7)
     haml (3.0.17)
     libxml-ruby (1.1.4)
     libxml4r (0.2.6)
@@ -20,14 +20,16 @@ GEM
       libxml4r
     rake (0.8.7)
     rspec (1.3.0)
+    yard (0.5.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  awesome_print
+  bluecloth (~> 2.0.7)
   bundler (~> 1.0.0.rc.5)
   geoffrey!
-  mocha (= 0.9.8)
+  mocha (~> 0.9.8)
   plist4r
-  rspec (= 1.3.0)
+  rspec (~> 1.3.0)
+  yard (~> 0.5.8)

data/Rakefile

@@ -3,5 +3,10 @@ Bundler::GemHelper.install_tasks
 
 desc "Execute specs"
 task :spec do
-  puts `bundle exec rspec spec`
+  puts `bundle exec spec spec`
+end
+
+desc "Generate docs"
+task :docs do
+  puts `bundle exec yardoc 'lib/**/*.rb'`
 end

data/geoffrey.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Albert Llop"]
   s.email       = ["mrsimo@gmail.com"]
-  s.summary     = "Geoffrey is a little helper to aid in the installation of packages and configuration of various Mac OSX applications."
-  s.description = File.read(File.dirname(__FILE__) + "/README.md")
+  s.summary     = "Help methods to install packages and configure applications for OSX"
+  s.description = "Geoffrey is a little helper to aid in the installation of packages and configuration of various Mac OSX applications."
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "geoffrey"
@@ -17,6 +17,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", "~> 1.0.0.rc.5"
   s.add_development_dependency "rspec", "~> 1.3.0"
   s.add_development_dependency "mocha", "~> 0.9.8"
+  s.add_development_dependency "yard", "~> 0.5.8"
+  s.add_development_dependency "bluecloth", "~> 2.0.7"
 
   s.add_dependency 'plist4r'
 

data/lib/geoffrey.rb

@@ -5,6 +5,37 @@ module Geoffrey
 
   class << self
 
+    # Define a package installation from the URL specified. It will download
+    # the file, and if it's compressed, it will decompress it.It currently
+    # supports zip and tar.gz files. Once extracted it will look for a .pkg
+    # file and try to install it.
+    #
+    # Some options can be defined:
+    #
+    # * +:sudo+ if it has to be executed as sudo.
+    # * +:unless+ a Proc defining if it doesn't have to try to install it.
+    # * +:file+ what file has to be installed from all of the ones that came in
+    #   the compressed file.
+    #
+    # If you don't want to install a .pkg but do something else, you can just
+    # override the install method. See the examples
+    #
+    # @example
+    #  Geoffrey.package do
+    #    url 'http://www.culater.net/dl/files/SIMBL-0.9.7a.zip'
+    #    options :sudo => true, :unless => Proc.new{ File.exists?("/Library/LaunchAgents/net.culater.SIMBL.Agent.plist") }
+    #  end
+    #
+    # @example
+    #  Geoffrey.package do
+    #    url "http://github.com/dabeeeenster/terminaltabswitching/raw/master/TerminalTabSwitching.bundle.zip"
+    #    options :file => "TerminalTabSwitching.bundle"
+    #    def install
+    #      plugins_dir = "#{ENV["HOME"]}/Library/Application Support/SIMBL/Plugins"
+    #      FileUtils.mkdir_p plugins_dir
+    #      FileUtils.mv file_to_install, plugins_dir, :force => true
+    #    end
+    #  end
     def package(&block)
       package = Package.new
       package.instance_eval &block
@@ -12,6 +43,30 @@ module Geoffrey
       package.install
     end
 
+    # Help you configure an application editing its +.plist+ file.
+    #
+    # You specify the file and then act on it through +options+ as if it were a
+    # simple hash.
+    #
+    # Some OSX applications dump their settings into the plist file when they
+    # quit, so you might want to stop them before applying changes. Geoffrey
+    # can do it for you with +affects+.
+    #
+    # @see Geoffrey::Plist::FILES A list of known config files.
+    #
+    # @example
+    #  Geoffrey.plist do
+    #    file :terminal
+    #    affects "/Applications/Utilities/Terminal.app"
+    #
+    #    options["Default Window Settings"] = "Pro"
+    #    options["Startup Window Settings"] = "Pro"
+    #    options["HasMigratedDefaults"] = true
+    #    options["Window Settings"]["Pro"]["Font"] = "bplist00\xD4\x01\x02\x03\x04\x05\x06\x18\x19X$versionX$objectsY$archiverT$top\x12\x00\x01\x86\xA0\xA4\a\b\x11\x12U$null\xD4\t\n\v\f\r\x0E\x0F\x10V$classVNSNameVNSSizeXNSfFlags\x80\x03\x80\x02\#@,\x00\x00\x00\x00\x00\x00\x10\x10]Menlo-Regular\xD2\x13\x14\x15\x16Z$classnameX$classesVNSFont\xA2\x15\x17XNSObject_\x10\x0FNSKeyedArchiver\xD1\x1A\eTroot\x80\x01\b\x11\x1A#-27<BKRY`ikmvx\x86\x8B\x96\x9F\xA6\xA9\xB2\xC4\xC7\xCC\x00\x00\x00\x00\x00\x00\x01\x01\x00\x00\x00\x00\x00\x00\x00\x1C\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xCE"
+    #    options["Window Settings"]["Pro"]["Font"].blob = true
+    #    options["Window Settings"]["Pro"]["columnCount"] = 520
+    #    options["Window Settings"]["Pro"]["rowCount"]    = 100
+    #  end
     def plist(&block)
       plist = Plist.new
       plist.instance_eval &block

data/lib/geoffrey/package.rb

@@ -4,6 +4,10 @@ require 'open-uri'
 require 'fileutils'
 
 module Geoffrey
+
+  # This class helps installing packages and other apps into your system.
+  #--
+  # TODO add support for .dmg files would be great
   class Package
     attr_accessor :url, :options, :format, :filename, :dir
 
@@ -11,6 +15,7 @@ module Geoffrey
       @options = {}
     end
 
+    # Accepts anything parseable by URI
     def url(val = nil)
       @url = val if val
       @url
@@ -21,6 +26,12 @@ module Geoffrey
       @options
     end
 
+    # Uses the url provided to download the file.
+    # Checks the options first to see if it shouldn't be done.
+    #--
+    # TODO raise some error if the file can't be found or something
+    # TODO add some option to define the file name for weird url's
+    # TODO ensure you can still download uncompressed files, right?
     def download_and_decompress
       return nil if shouldnt_install
 
@@ -42,6 +53,9 @@ module Geoffrey
       end
     end
 
+    # Does the actual installing of the package
+    #--
+    # TODO add support for .dmg files
     def install
       return nil if shouldnt_install
 
@@ -58,6 +72,8 @@ module Geoffrey
       @options[:unless] && @options[:unless].respond_to?(:call) && @options[:unless].call
     end
 
+    # Simple wrapper to execute things, using sudo or not as per defiend in the
+    # options. Useful for debugging too :)
     def execute(command, options = {})
       options = @options.merge(options)
       command = "sudo #{command}" if options[:sudo]
@@ -67,6 +83,8 @@ module Geoffrey
 
     # If it was specified through options, then get that, otherwise
     # get the first file with .pkg extension
+    #--
+    # TODO Also use .dmg when support is added
     def file_to_install
       if @options[:file]
         "#{@dir}/#{@options[:file]}"
@@ -90,6 +108,11 @@ module Geoffrey
       end
     end
 
+    # Actual decompressing of the file. Does so into a directory we created in
+    # +#{Dir.tmpdir}/#{filename}+
+    #--
+    # TODO better isolate each download inside the tmpdir?
+    # TODO have gzips actually work
     def decompress(file,target)
       command = case @format
       when :zip

data/lib/geoffrey/plist.rb

@@ -1,6 +1,8 @@
 require 'plist4r'
 
 module Geoffrey
+
+  # This class helps you configure your Applications
   class Plist
 
     FILES = {
@@ -10,6 +12,8 @@ module Geoffrey
 
     attr_accessor :data, :file, :process
 
+    # Set the file you'll edit. if you pass a symbol then it'll use the file
+    # defined in the FILES hash.
     def file(file = nil)
       if file
         file = FILES[file] if Symbol === file
@@ -20,6 +24,7 @@ module Geoffrey
       @file
     end
 
+    # If a process must be killed before we change settings
     def affects(value)
       @process = value
     end
@@ -36,6 +41,9 @@ module Geoffrey
       data[key] = value
     end
 
+    # Saves the changes defined into the file.
+    #--
+    # TODO don't reopen the process if it wasn't opened to begin with
     def save
       kill
       data.save

data/lib/geoffrey/version.rb

@@ -1,3 +1,3 @@
 module Geoffrey
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Albert Llop
@@ -65,9 +65,39 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: plist4r
+  name: yard
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 8
+        version: 0.5.8
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 7
+        version: 2.0.7
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: plist4r
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -76,56 +106,8 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id004
-description: "geoffrey\n\
-  ========\n\n\
-  ## ALERT!\n\n\
-  This is very early alpha code, use with precaution. It's a spinoff of myself willing to\n\
-  improve my [dotfiles project](http://github.com/albertllop/dotfiles) a step further. All\n\
-  code examples in this README come from it.\n\n\
-  ## Introduction\n\n\
-  Geoffrey's your little helper, that who just wants to makes your life easier.\n\n\
-  It aims to help you create little scripts to setup your OSX the way you like.\n\
-  If, like me, you use different computers at work, home, or even when travelling,\n\
-  you'll know it's a pain in the ass to keep everything up to date.\n\n\
-  Inspired in the numerous dotfiles projects, specially\n\
-  [holman's](http://github.com/holman/dotfiles),\n\
-  the intention is to bring customization to a bigger extend.\n\n\
-  ## Installation\n\n     $ [sudo] gem install geoffrey\n\n\
-  Geoffrey's Talents\n\
-  ==================\n\n\
-  Geoffrey has many talents, and thus you'll find he can help you in one of these areas:\n\n\
-  ## Packages\n\n\
-  If you ever used [Ciar\xC3\xA1n Walsh's](http://ciaranwal.sh) SIMBL plugins, you'll remember\n\
-  what a pain it is to install them every time. Now you can do so with the next piece of code:\n\n    require 'geoffrey'\n    Geoffrey.package do\n      url 'http://www.culater.net/dl/files/SIMBL-0.9.7a.zip'\n      options :sudo => true, :unless => Proc.new{ File.exists?(\"/Library/LaunchAgents/net.culater.SIMBL.Agent.plist\") }\n    end\n\n\
-  Geoffrey will take care of downloading the zip file, and install whatever .pkg\n\
-  file is in the zip. The possible options are:\n\n\
-  * `:sudo` => in case it needs to be executed as sudo to install (it does if the installer would ever ask for your password)\n\
-  * `:unless` => in order to make running this idempotent.\n\
-  * `:file` => specify which of the files contained in the zip has to be installed. If it's not specified it uses the first .pkg it finds.\n\n\
-  With that you'll have SIMBL installed and working. Now suppose you want to install a bundle.\n\
-  You'd have to download a file, and move it to a directory. Geoffrey can help you a little,\n\
-  basically downloading and uncompressing the zip, and you just have to define the install\n\
-  method.\n\n    require 'geoffrey'\n    Geoffrey.package do\n      url \"http://github.com/dabeeeenster/terminaltabswitching/raw/master/TerminalTabSwitching.bundle.zip\"\n      options :file => \"TerminalTabSwitching.bundle\"\n\n      def install\n        plugins_dir = \"#{ENV[\"HOME\"]}/Library/Application Support/SIMBL/Plugins\"\n        FileUtils.mkdir_p plugins_dir\n        FileUtils.mv file_to_install, plugins_dir, :force => true\n      end\n\n    end\n\n\
-  `file_to_install` is provided by geoffrey poiting to the automatically downloaded/uncompressed file.\n\n\
-  ## Application Configuration\n\n\
-  Everything in OSX seems to work around `.plist` files. This takes a little bit of work to figure out,\n\
-  but once you do, you can have your favourite apps the way you like. This is my script to get Terminal.app\n\
-  up and running with Pro scheme, Menlo Font 14pt, and a size 520x100.\n\n    require 'geoffrey'\n\n    Geoffrey.plist do\n      file :terminal\n      affects \"/Applications/Utilities/Terminal.app\"\n\n      options[\"Default Window Settings\"] = \"Pro\"\n      options[\"Startup Window Settings\"] = \"Pro\"\n      options[\"HasMigratedDefaults\"] = true\n      options[\"Window Settings\"][\"Pro\"][\"Font\"] = \"bplist00\\xD4\\x01\\x02\\x03\\x04\\x05\\x06\\x18\\x19X$versionX$objectsY$archiverT$top\\x12\\x00\\x01\\x86\\xA0\\xA4\\a\\b\\x11\\x12U$null\\xD4\\t\\n\\v\\f\\r\\x0E\\x0F\\x10V$classVNSNameVNSSizeXNSfFlags\\x80\\x03\\x80\\x02\\#@,\\x00\\x00\\x00\\x00\\x00\\x00\\x10\\x10]Menlo-Regular\\xD2\\x13\\x14\\x15\\x16Z$classnameX$classesVNSFont\\xA2\\x15\\x17XNSObject_\\x10\\x0FNSKeyedArchiver\\xD1\\x1A\\eTroot\\x80\\x01\\b\\x11\\x1A#-27<BKRY`ikmvx\\x86\\x8B\\x96\\x9F\\xA6\\xA9\\xB2\\xC4\\xC7\\xCC\\x00\\x00\\x00\\x00\\x00\\x00\\x01\\x01\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x1C\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\xCE\"\n      options[\"Window Settings\"][\"Pro\"][\"Font\"].blob = true\n      options[\"Window Settings\"][\"Pro\"][\"columnCount\"] = 520\n      options[\"Window Settings\"][\"Pro\"][\"rowCount\"]    = 100\n    end\n\n\
-  * `file` => Geoffrey knows of a few files in your system you can specify with symbols. If you want to work with a different one, just write the full path.\n\
-  * `affects` => When you close Terminal.app, it'll dump its otions into the plist. So you have to stop it, change the plist file, then reopen it. Geoffrey does this automatically if you tell him what must be rebooted.\n\
-  * `options` => Its the plist has per se. Using the fantastic [plist4r](http://github.com/dreamcat4/plist4r) gem, you can modify it.\n\n\
-  You might have seen something peculiar:\n\n    options[\"Window Settings\"][\"Pro\"][\"Font\"].blob = true\n\n\
-  Some values in plist files are of type \"Data\", which is just binary stuff. Plist4r handles\n\
-  these as strings with a special flag.\n\n\
-  The best way to know what to put in every value, is to just go to the file and take a\n\
-  look. They all tend to make sense. For data values, however, you might have more work. The\n\
-  way I do it is opening the file with Plist4r, and reading the value:\n\n    require 'plist4r'\n    plist = Plist4r.open(\"the/file.plist\")\n    plist[\"whatever\"][\"option\"] # => copy whatever it returns\n\n\
-  Just make sure that when you set it in your geoffrey you put the flag blog true. Otherwise you might see some really weird system errors.\n\n\
-  ## A few words\n\n\
-  This is work done in my free hours, it's not yet finished. The code is dirty and mainly undocumented. It all started on #whyday,\n\
-  but I'm so lazy that I've needed a lot of time to do just this. \n\n\
-  Thanks!\n"
+  version_requirements: *id006
+description: Geoffrey is a little helper to aid in the installation of packages and configuration of various Mac OSX applications.
 email: 
 - mrsimo@gmail.com
 executables: []
@@ -144,7 +126,6 @@ files:
 - lib/geoffrey.rb
 - lib/geoffrey/package.rb
 - lib/geoffrey/plist.rb
-- lib/geoffrey/template.rb
 - lib/geoffrey/version.rb
 - spec/package_spec.rb
 - spec/plist_spec.rb
@@ -188,6 +169,6 @@ rubyforge_project: geoffrey
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Geoffrey is a little helper to aid in the installation of packages and configuration of various Mac OSX applications.
+summary: Help methods to install packages and configure applications for OSX
 test_files: []
 

data/lib/geoffrey/template.rb

@@ -1,30 +0,0 @@
-module Geoffrey
-  class Template
-
-    attr_accessor :title, :description
-
-    def self.inherited(subclass)
-      @@subclasses ||= []
-      @@subclasses << subclass
-    end
-
-    class << self
-      def self.attr_rw(*attrs)
-        attrs.each do |attr|
-          class_eval %Q{
-            def #{attr}(val=nil)
-              val.nil? ? @#{attr} : @#{attr} = val
-            end
-          }
-        end
-      end
-
-      attr_rw :title, :description
-
-      def all
-        @@subclasses
-      end
-
-    end
-  end
-end