app_mode 0.0.3 → 0.0.4

data/README

@@ -11,7 +11,7 @@ the state that a class, module, library, script, or application is running in.
 
 2. Require the gem in your gemfile:
 
-    gem 'app_mode', '~> 0.0.1'
+    gem 'app_mode', '~> 1.0.0'
 
 3. Require the gem wherever you need state management:
 
@@ -64,8 +64,6 @@ There are two ways to use this gem.
 2. Use the class methods:
    This method is really only recommended for the end application. The initial
    state will be set dynamically, so there is nothing to do except use it.
-   Only the default states (see "A Word on States" below) are available
-   using this method.
 
     if AppMode.state == :development
       # Development code.
@@ -79,6 +77,12 @@ There are two ways to use this gem.
 
 == Usage in libraries/gems
 
+Following these guidelines consumers of your library or gem will still have
+access to the state of your gem and can control it, if need be. Otherwise,
+changing AppMode.state to :development could put every gem that uses AppMode
+into "development" mode, which is probably not what you want to have happen
+to your gem or anyone else's.
+
 The following method is recommended for use in libraries or gems:
 
   module MyModule
@@ -105,9 +109,9 @@ or
 
 * There is a fifth state (:dynamic), which will tell AppMode to determine
   the state by examining the stack trace. It is only available when initializing
-  a new AppMode object and assumes that the first state is 'development', the
-  second is 'test', the third is 'rake', and the last one (not the fourth) is
-  'production'. If less than four states are specified, the last one will be
+  a new AppMode object and assumes that the first state is 'development',
+  the second is 'test', the third is 'rake', and the last one (not the fourth)
+  is 'production'. If less than four states are specified, the last one will be
   used for multiple states. For example, if the states specified are
   [:orange, :apple, :grape], :grape will be used for both rake and production.
 
@@ -142,6 +146,18 @@ or
      # Purple code.
    end
 
+* If you are compelled to change the states for the global AppMode class,
+  that may be done by using the setup method, which accepts the same
+  arguments as AppMode.new. Passing in a state of :dynamic will allow it
+  to set the state as it is intended.
+
+* Although this document explains how to do so,
+  it is best to leave AppMode (its valid states and its state) unaltered,
+  as such changes are global and could have unexpected results when other code
+  (such as gems) may be relying on the default settings, even though
+  it is recommended that they have their own object that should
+  be made available to your code.
+
 == Additional Documentation
 
  rake rdoc:app

data/app_mode.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'app_mode'
-  s.version = '0.0.3'
+  s.version = '0.0.4'
 
   s.summary = 'Application state management.'
   s.description = 'AppMode provides state management for ' +

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Travis Herrick
@@ -66,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2217336874542399798
+      hash: 1255421514984567375
       segments: 
       - 0
       version: "0"