thin-ice 0.1.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTkyOTk2MzcyZTdiMDIyNmNhOGEyYWYxNTAxYmY3NDRkYmY1YjIwZg==
+    ZDNjOTI2MWIwOGZmOGIwYTdhZWNmNmJhODM5NzUzYWE5ZWIwZDQ4OQ==
   data.tar.gz: !binary |-
-    ZjNmYzhjNjgyOTcxY2Y1M2UzN2I2OWYyZTYzMDI3NjZmZDY2YzEzYg==
+    YTY2MDcwYzE0YjE1NjJhMjNlMWU3MjljZTM5ZTNkMzdkZTcyMmMxZg==
 SHA512:
   metadata.gz: !binary |-
-    ODZiNmRkYjJlNzg4MGU0YjZhNzIwODAzYmFiZTA1ZTEzOTVkN2Q2YjVkMmVh
-    ZTUwZDU1YWUwM2YyNGYyMGYzODU2MmM5ODg3MDEzOGYyODE5MjQ3ODA0Nzky
-    MjhkMzk0YzlmNTgwZTM0OWQ4N2MyMjE2MmFlMWVhYTM0ZWJhYTI=
+    MzBiYWY4YjNkNmE5YmNhNzQ3YmRlZWYxNTRiNDE1MjZjYTI2YWVhZjlkNDFh
+    NmU1MGI3ZjU1MTkyOWU0ZjQzMmQ4OGIxM2FhODliMDFlNWZmMWI3OTM3ZTM4
+    YjRiZmUxYWU3NTc2YWUwNDUzMWJlNzU4MjRmZTYzMzNiNTE0YTU=
   data.tar.gz: !binary |-
-    Y2ZkMzBhMzhlNmQ3MTZhZjNmZDRjYjYzMWYyNDZhMjlkOGM4OWQ4Yzk0OTk3
-    NjI4N2UzOGZmMzJhMDgyMjA1MjFkYTRjNzliMTRmMjJiMmNmYzUwM2Q0Y2Nj
-    MTY1OWNhZThhZjU3NGY3ZGM4MjQ4YTIyNzkzZTRkMmRlZjc1MGM=
+    MTg0MmNlZDRkNjYyYWIwNzdkYWEwZTM5YTcwMzA0Mjg1MGQyNzExZGE1ZWU5
+    MDk3MDgyNjBhOWE1ZDc4NWU2MmM2MDkzMGEwMmJkZGZhYzg1YTkwYzk1ZWE1
+    YWUyMmRmZDk4OWI3OTVhZWY4YjA0MGFkZGY1MGExNTMyNzk4MzI=

data/lib/thin-ice/core.rb

@@ -1,12 +1,18 @@
 require 'rake'
 
+# @author Alex Bezobchuk
 module ThinIce
   extend Rake::DSL
 
-  class ThinCommandFailure < StandardError
-  end
+  # A custom Exception to be thrown when an undesired exit status
+  # is returned when spawning a process.
+  class ThinCommandFailure < StandardError; end
 
-  # Helper method for invoking god commands
+  # Forks a process given a list of arguments and options
+  # @param args [String] list of command arguments and options
+  # @return [Integer] the resulting exit status
+  # @raise [ThinCommandFailure] if the exit status of the process
+  #   is non-zero
   def self.invoke(args)
     pid = Process.spawn(*args)
     _, result = Process.wait2(pid)
@@ -17,47 +23,70 @@ module ThinIce
     end
   end
 
+  # ThinManager is designed to help construct the exact command to be excuted
+  # by the Rake task.
   class ThinManager
 
-    attr_accessor :env, :config_path, :thin_path, :rackup_path
-
+    # @!attribute env [String] Environment
+    # @!attribute config_path [String] Path to YML configuration file
+    # @!attribute thin_path [String] Path to Thin executable
+    # @!attribute rackup_path [String] Path to Rackup configuration
+    attr_reader :env, :config_path, :thin_path, :rackup_path
+
+    # Creates a [ThinManager] object that is used to to aid rake task
+    #   generation
+    # @param options [Hash] Hash containing various configuration
+    #   options
+    # @return [ThinManager] ThinManager object
     def initialize(options = {})
       @env             = options[:env]
-      @thin_path       = options[:thin_path]      
+      @thin_path       = options[:thin_path]
       @config_path     = options[:config_path]
       @rackup_path     = options[:rackup_path]
     end
 
-
-    # Helper methods for generating fragments of thin commands
+    # @return [Array] An Array cotaining the environment string. May be
+    #   empty
     def env_param
       (env) ? [env] : []
     end
 
+    # @return [Array] An Array cotaining the Thin executable location. Uses
+    #   local Thin gem by default
     def thin_exec_param
       [thin_path || "thin"]
     end
 
+    # @return [Array] An Array cotaining the path to a YML configuration file.
+    #   Empty by default
     def config_path_param
       (config_path) ? ["-C", config_path] : []
     end
 
+    # @return [Array] An Array cotaining the path to a Rackup configuration file.
+    #   Empty by default
     def rackup_path_param
       (rackup_path) ? ["-R", rackup_path] : []
     end
 
-    # Helper methods for generating thin commands
-
+    # @return [String] A concatination of strings resulting in the Thin
+    #   start command to be invoked by Rake
     def start_cmd
       env_param + thin_exec_param + rackup_path_param + config_path_param + ["start"]
     end
 
+    # @return [String] A concatination of strings resulting in the Thin
+    #   stop command to be invoked by Rake
     def stop_cmd
       env_param + thin_exec_param + rackup_path_param + config_path_param + ["stop"]
     end
 
   end
 
+  # Generates a set of Rake tasks to be used within a specific namespace
+  #   that handle starting and stoping a Thin server instance
+  # @param options [Hash] Hash containing various configuration
+  #   options
   def self.create_tasks(options = {})
 
     thin_manager = ThinManager.new(options)
@@ -73,5 +102,4 @@ module ThinIce
     end
 
   end
-
 end

data/lib/thin-ice/version.rb

@@ -0,0 +1,3 @@
+module ThinIce
+  VERSION = "1.0.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thin-ice
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Bezobchuk
@@ -38,15 +38,58 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-description: Rake task generator for starting a thin server given a rackup file and
-  YML configuration file.
-email: abezobchuk@jibe.com
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Rake task generator for spinning up a thin server with easy to use configuration
+  options.
+email: abezobchuk@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/thin-ice.rb
 - lib/thin-ice/core.rb
+- lib/thin-ice/version.rb
+- lib/thin-ice.rb
 homepage: https://github.com/Alexanderbez/thin-ice
 licenses:
 - MIT
@@ -67,8 +110,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Rake task generator for starting a thin server
+summary: Rake task generator for spinning up a thin server.
 test_files: []
+has_rdoc: