which_osx 1.0.4 → 1.0.5

data/README.md

@@ -1,12 +1,10 @@
 # which_osx
 
-![The contemplative Mac](http://i.imgur.com/RNIc8.png)
-
 - http://github.com/imkmf/which_osx
 
 ## DESCRIPTION:
 
-A simple ruby program for outputting some information about your Mac.
+A simple ruby program for outputting some information about your Mac's version, as well as some clever ways of intepreting it.
 
 ## FEATURES/PROBLEMS:
 
@@ -16,36 +14,48 @@ A simple ruby program for outputting some information about your Mac.
 
 ## USAGE:
 
-which_osx can be imported into a project and used to return the current version of OS X (as of writing, my computer returns "10.7.3"):
+By requiring which_osx, you gain access to a couple useful methods:
+
+### WhichOSX.version
+
+    puts WhichOSX.version
+    => 10.8.2
 
-    require 'which_osx'
+### WhichOSX.full_name
+    
+    puts WhichOSX.full_name
+    => Mac OS X 10.8.2
 
-    module ForTheREADME
-      def self.test
-          who_am_i = WhichOSX.version
-        end
-    end
+### WhichOSX.short_name
 
-which_osx version 1.0.3 adds new methods for different outputs:
+    puts WhichOSX.short_name
+    => Mountain Lion
 
-    $ WhichOSX.full_name
-    => Mac OS X 10.7.3
+WhichOSX version 1.0.5 introduces boolean methods for checking the operating system:
 
-    $ WhichOSX.short_name
-    => Lion
+### WhichOSX.is_mountain_lion
+    
+    WhichOSX.is_mountain_lion
+    => true
+
+Includes `is_mountain_lion`, `is_lion`, `is_snow_leopard`, `is_leopard`, and `is_tiger`.
+
+### Binary
 
 Running from the command line returns the OS version by default:
 
     $ which_osx   
-    => 10.7.3
+    => This Mac is currently running 10.8.2.
 
 ## REQUIREMENTS:
 
-- None
+- [Rspec](http://rspec.info)
+- [YARD](http://yardoc.org) (and [redcarpet](http://yardoc.org) for Markdown formatting)
+
 
 ## INSTALL:
 
-    sudo gem install which_osx
+    gem install which_osx
 
 ## DEVELOPERS:
 

data/Rakefile

@@ -3,24 +3,24 @@ require 'rubygems/package_task'
 require 'rake/rdoctask' unless RUBY_VERSION >= '1.9.0'
 require 'rdoc/task' unless RUBY_VERSION <= '1.9.0'
 require 'rubygems/specification'
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
+require 'yard'
 
 spec = Gem::Specification.load("#{File.dirname(__FILE__)}/which_osx.gemspec")
 
 task :default => :spec
 
-desc "Run specs"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
-  t.spec_opts = %w(-fs --color)
-  t.libs << ["spec", '.']
+# Generate docs
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']   # optional
+  t.options = ['--any', '--extra', '--opts'] # optional
 end
 
-desc "Run all examples with RCov"
-Spec::Rake::SpecTask.new('spec:rcov') do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
-  t.rcov = true
-  t.rcov_opts = ['-T', '--sort', 'coverage', '--exclude', 'gems/*,spec/*']
+# Run specs
+desc "Run specs"
+RSpec::Core::RakeTask.new(:core) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
 end
 
 # Gem tasks

data/bin/which_osx

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'which_osx'
+
+puts "This Mac is currently running #{ WhichOSX.version }"

data/lib/version.rb

@@ -1,3 +1,3 @@
 module WhichOsx
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/which_osx.rb

@@ -7,7 +7,13 @@ output = `sw_vers`.scan(/\d\d\.\d\.\d/).flatten.to_s
 output.delete! "[]\""
 VERSION = output
 
-module WhichOSX
+class WhichOSX
+
+  # Get the version of OS X currently running. 
+  # This method returns something in the format of 
+  # "XX.X.X" - it is used to help the rest of the commands
+  # execute properly.
+
   def self.version
     short_version = VERSION
     return short_version
@@ -17,11 +23,17 @@ module WhichOSX
     
   end
 
+  # Get the full name including version.
+  # Will always return "Mac OS X XX.X.X"
+
   def self.full_name
     full_name = "Mac OS X " + VERSION
     return full_name
   end
 
+  # Returns the common name for the operating system,
+  # such as "Mountain Lion" or "Tiger".
+
   def self.short_name
     # We just want the major versions -- 10.6, 10.7, etc.
     major_version = VERSION.chop.chop
@@ -41,4 +53,46 @@ module WhichOSX
 
     return short_name
   end
+
+  # A helper method for boolean checks. Compares the short name
+  # to the given version name and returns true or false accordingly.
+
+  def self.is(version)
+    if short_name == version
+      return true
+    else
+      return false
+    end
+  end
+
+  # Checks if the operating system is currently running Mountain Lion.
+
+  def self.is_mountain_lion
+    self.is("Mountain Lion")
+  end
+
+  # Checks if the operating system is currently running Lion.
+
+  def self.is_lion
+    self.is("Lion")
+  end
+
+  # Checks if the operating system is currently running Snow Leopard.
+
+  def self.is_snow_leopard
+    self.is("Snow Leopard")
+  end
+
+  # Checks if the operating system is currently running Leopard.
+
+  def self.is_leopard
+    self.is("Leopard")
+  end
+
+  # Checks if the operating system is currently running Tiger.
+
+  def self.is_tiger
+    self.is("Tiger")
+  end
+  
 end

data/spec/which_osx_spec.rb

@@ -9,23 +9,19 @@ require 'which_osx'
     end
 
     it "should convert version to a nice string" do
-      WhichOSX.version.should =~ /[0-9][0-9].[0-9].[0-9]/
+      WhichOSX.version.should =~ /1[0-9].[0-9].[0-9]/
     end
-
-    # it "should tell you when you're not on Mac OS X" do
-    #   # how best to mock a non-Mac OS X environment?
-    # end
   end
 
   describe "full name" do
     it "should return the full name of the OS" do
-      WhichOSX.full_name.should =~ /Mac OS X [0-9][0-9].[0-9].[0-9]/
+      WhichOSX.full_name.should =~ /Mac OS X 1[0-9].[0-9].[0-9]/
     end
   end
 
   describe "short name" do
     it "should chomp the version into a major release number" do
-      WhichOSX.version.chop.chop.should =~ /[0-9][0-9].[0-9]/
+      WhichOSX.version.chop.chop.should =~ /1[0-9].[0-9]/
     end
 
     it "should return a major release name (Lion, Leopard, etc.)" do
@@ -33,3 +29,9 @@ require 'which_osx'
     end
   end
 
+  describe "is... checks" do
+    it "should return true if the OS is Mountain Lion" do
+      WhichOSX.is_mountain_lion.should be_true
+    end
+  end
+

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: which_osx
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
 - Kristian Freeman
-autorequire: ''
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-21 00:00:00.000000000 Z
+date: 2012-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,6 +27,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -46,8 +78,9 @@ dependencies:
 description: A simple ruby program for returning the version number of the current
   Mac OS X system.
 email:
-- kristian@kayeff.me
-executables: []
+- kristian@kristianfreeman.com
+executables:
+- which_osx
 extensions: []
 extra_rdoc_files: []
 files:
@@ -58,6 +91,7 @@ files:
 - lib/version.rb
 - lib/which_osx.rb
 - spec/which_osx_spec.rb
+- bin/which_osx
 homepage: http://github.com/imkmf/which_osx
 licenses: []
 post_install_message: 
@@ -78,9 +112,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A simple ruby program for returning the version number of the current Mac
   OS X system.
 test_files: []
+has_rdoc: false