plow 0.1.0 → 1.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: plow
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Ryan Sobol
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-27 00:00:00 +08:00
+date: 2009-11-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   type: :development
@@ -20,7 +30,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 1.2.8
+        version: 1.2.9
     version: 
 - !ruby/object:Gem::Dependency 
   name: yard
@@ -30,7 +40,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.2.3.5
+        version: 0.4.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: bluecloth
@@ -55,31 +65,32 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - .yardopts
-- HISTORY
 - LICENSE
 - README.markdown
-- ROAD-MAP
 - Rakefile
-- SECURITY
 - VERSION
 - bin/plow
 - bin/plow1.9
+- doc/HISTORY.markdown
+- doc/ROAD-MAP.markdown
+- doc/SECURITY.markdown
 - lib/plow.rb
 - lib/plow/application.rb
 - lib/plow/binding_struct.rb
 - lib/plow/core_ext/object.rb
+- lib/plow/dependencies.rb
 - lib/plow/errors.rb
 - lib/plow/generator.rb
-- lib/plow/strategy/ubuntu_hardy/templates/README.txt
+- lib/plow/strategy/ubuntu_hardy.rb
 - lib/plow/strategy/ubuntu_hardy/templates/apache2-vhost.conf
-- lib/plow/strategy/ubuntu_hardy/user_home_web_app.rb
 - spec/fixtures/passwd.txt
 - spec/fixtures/vhost.conf
 - spec/plow/application_spec.rb
 - spec/plow/binding_struct_spec.rb
+- spec/plow/dependencies_spec.rb
 - spec/plow/errors_spec.rb
 - spec/plow/generator_spec.rb
-- spec/plow/strategy/ubuntu_hardy/user_home_web_app_spec.rb
+- spec/plow/strategy/ubuntu_hardy_spec.rb
 - spec/plow_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -94,9 +105,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - ~>
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.9.1
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
@@ -114,8 +125,9 @@ summary: Plows the fertile soil of your filesystem into neatly organized plots o
 test_files: 
 - spec/plow/application_spec.rb
 - spec/plow/binding_struct_spec.rb
+- spec/plow/dependencies_spec.rb
 - spec/plow/errors_spec.rb
 - spec/plow/generator_spec.rb
-- spec/plow/strategy/ubuntu_hardy/user_home_web_app_spec.rb
+- spec/plow/strategy/ubuntu_hardy_spec.rb
 - spec/plow_spec.rb
 - spec/spec_helper.rb

data/HISTORY

@@ -1,39 +0,0 @@
-== 1.0.0 released on Oct. ??th 2009
-
-  * bin/plow and bin/plow1.9
-    * Two ruby 1.9.1 compatible command-line executables.
-    * Combined with Plow::Application, the entire application logic is decoupled from the plow generator library.
-  * lib/plow.rb
-    * Handles load-time errors gracefully for the user
-    * Specifies library-wide load order
-    * Maintains the library version in memory
-  * lib/plow/application.rb
-    * decoupled argument parsing from the generator
-    * displays usage for the command-line executables
-    * handles run-time errors gracefully for the user
-    * starts the generator
-    * Combined with the executables, the entire application logic is decoupled from the plow generator library.
-  * lib/plow/generator.rb
-    * main controller
-    * maintains the shared state data including a strategy object
-    * passes execution to the strategy object
-    * provides shared logic for outputting messages to the user
-    * provides shared logic for executing shell commands
-    * provides shared logic for evaluating ERB template files
-  * lib/plow/binding_struct.rb
-    * helper object that converts a Hash object into instances variables, which then is used as the binding object for ERB
-  * lib/plow/core_ext/object.rb
-    * dynamically adds a #blank? method to all objects (copied directly from the active_support library)
-  * lib/plow/errors.rb
-    * defines a handful of run-time error classes
-  * lib/plow/strategy/ubuntu_hardy/user_home_web_app.rb
-    * userhome-based strategy for generating a system-wide web-site structure for the Linux Ubuntu Hardy 8.04.3 LTS operating system
-      * understanding and managing the security implications of web server of virtual hosts
-  * lib/plow/strategy/ubuntu_hardy/templates/apache2-vhost.conf
-    * a simple apache2 virtual host ERB template file for the Linux Ubuntu Hardy 8.04.3 LTS operating system
-  * lib/plow/strategy/ubuntu_hardy/templates/README.txt
-    * a README file that explains the generated web-site directory structure and files
-  * Rakefile
-    * incorporating deployments with jeweler and gemcutter.  the combination is extremely powerful and seems alot more practical than maintaining my own rubygem server.  
-    
-  * inviting others to review my code and submitting patches!  long live the open-source community!

data/ROAD-MAP

@@ -1,10 +0,0 @@
-== Improvements
-
-The obvious potential improvements are ported the package to additional operating systems and web servers.  This would require minimal, but completely worth-while structure changes Plow::Generator class.
-  
-  * Move all system administrative logic to model classes and redesign the class around the builder pattern to allow to construct user-determined classes dynamically at run-time
-  * Move all data validations to the same model classes or to new classes entirely, depending on the needs at the time
-  * More specific data validations
-  * Handing of more complex web application structures
-  * automatic deployment of web applications from github
-  * better argument parsing and including option flags as needed

data/lib/plow/strategy/ubuntu_hardy/templates/README.txt

@@ -1,19 +0,0 @@
-$ tree sites/
-sites/
-|-- README
-`-- example.ryansobol.com
-    |-- log
-    |   `-- apache2
-    |       |-- access.log
-    |       `-- error.log
-    `-- public
-        `-- index.html
-
-4 directories, 4 files
-
-$ ls -hal sites/example.ryansobol.com/log/apache2/
-total 196K
-drwxr-x--- 2 root GROUP 4.0K Sep  5 03:11 .
-drwxr-xr-x 3 USER GROUP 4.0K Sep  5 03:09 ..
--rw-r----- 1 root GROUP 136K Sep  9 11:10 access.log
--rw-r----- 1 root GROUP  48K Sep  9 09:06 error.log

data/lib/plow/strategy/ubuntu_hardy/user_home_web_app.rb

@@ -1,304 +0,0 @@
-# encoding: UTF-8
-
-class Plow
-  class Strategy
-    class UbuntuHardy
-      
-      ##
-      # Plowing strategy, compatible with the Linux Ubuntu Hardy Heron distribution, for generating
-      # a web-site within a user home directory.
-      class UserHomeWebApp
-        attr_reader :context, :users_file_path, :vhost_file_name, :vhost_file_path, :vhost_template_file_path
-        attr_reader :user_home_path, :sites_home_path, :app_root_path, :app_public_path, :app_log_path
-        
-        ##
-        # @param [Plow::Generator] context A context reference to the generator controller. (i.e. Strategy pattern)
-        #
-        # @example
-        #   class Plow
-        #     class Generator
-        #       def initialize
-        #         @strategy = Plow::Strategy::UbuntuHardy::UserHomeWebApp.new(self)
-        #       end
-        #     end
-        #   end
-        def initialize(context)
-          @context         = context
-          @users_file_path = "/etc/passwd"
-          @vhost_file_name = "#{context.site_name}.conf"
-          @vhost_file_path = "/etc/apache2/sites-available/#{vhost_file_name}"
-          
-          @vhost_template_file_path = "#{File.dirname(__FILE__)}/templates/apache2-vhost.conf"
-        end
-        
-        ##
-        # Begins executing this strategy.  In addition to the following exceptions, this method may
-        #   also raise exceptions found in private methods of this class.
-        #
-        # @raise [Plow::AppRootAlreadyExistsError] Raised if the web-app root path directory
-        #   aleady exists
-        # @raise [Plow::ConfigFileAlreadyExistsError] Raised if a apache2 vhost configuration file
-        #   cannot be found
-        def execute
-          if user_exists?
-            say "existing #{context.user_name} user"
-          else
-            say "creating #{context.user_name} user"
-            create_user
-          end
-          
-          if user_home_exists?
-            say "existing #{user_home_path}"
-          else
-            say "creating #{user_home_path}"
-            create_user_home
-          end
-          
-          if sites_home_exists?
-            say "existing #{sites_home_path}"
-          else
-            say "creating #{sites_home_path}"
-            create_sites_home
-          end
-          
-          if app_root_exists?
-            raise(Plow::AppRootAlreadyExistsError, app_root_path)
-          else
-            say "creating #{app_root_path}"
-            create_app_root
-          end
-          
-          @app_public_path = "#{app_root_path}/public"
-          say "creating #{@app_public_path}"
-          create_app_public
-          
-          @app_log_path = "#{app_root_path}/log"
-          say "creating #{app_log_path}"
-          create_app_logs
-          
-          if vhost_config_exists?
-            raise(Plow::ConfigFileAlreadyExistsError, vhost_file_path)
-          else
-            say "creating #{vhost_file_path}"
-            create_vhost_config
-          end
-          
-          say "installing #{vhost_file_path}"
-          install_vhost_config
-        end
-        
-        ############################################################################################################
-        
-        private
-        
-        ##
-        # Proxy method to +Plow::Generator#say+
-        # @param [String] message A user output message
-        def say(message)
-          context.say(message)
-        end
-        
-        ##
-        # Proxy method to +Plow::Generator#shell+
-        # @param [String] commands Shell commands with multi-line support.
-        def shell(commands)
-          context.shell(commands)
-        end
-        
-        ##
-        # Reads the file at +users_file_path+ and yields each user iteratively.
-        #
-        #
-        # @yield [Hash] Each user account
-        # @example
-        #   users do |user|
-        #     user[:name]        #=> [String] The name
-        #     user[:password]    #=> [String] The bogus password
-        #     user[:id]          #=> [Number] The uid number
-        #     user[:group_ip]    #=> [Number] The gid number
-        #     user[:info]        #=> [String] General account info
-        #     user[:home_path]   #=> [String] The path to the home directory
-        #     user[:shell_path]  #=> [String] The path to the default shell
-        #   end
-        def users(&block)
-          File.readlines(users_file_path).each do |user_line|
-            user_line = user_line.chomp.split(':')
-            user = {
-              :name       => user_line[0],
-              :password   => user_line[1],
-              :id         => user_line[2].to_i,
-              :group_id   => user_line[3].to_i,
-              :info       => user_line[4],
-              :home_path  => user_line[5],
-              :shell_path => user_line[6]
-            }
-            yield user
-          end
-        end
-        
-        ############################################################################################################
-        
-        ##
-        # Determines if the context.user_name already exists or not
-        # 
-        # @return [Boolean] +true+ if found otherwise +false+
-        # @raise [Plow::ReservedSystemUserNameError] Raised if the +context.user_name+ is a reserved
-        #   system user name
-        def user_exists?
-          users do |user|
-            if user[:name] == context.user_name
-              unless user[:id] >= 1000 && user[:id] != 65534
-                raise(Plow::ReservedSystemUserNameError, context.user_name)
-              end
-              return true
-            end
-          end
-          
-          return false
-        end
-        
-        ##
-        # Creates a system user account for +context.user_name+
-        def create_user
-          shell "adduser #{context.user_name}"
-        end
-        
-        ############################################################################################################
-        
-        ##
-        # Determines if a home path for the +context.user_name+ already exists
-        #
-        # @return [Boolean] +true+ if the path already exists, otherwise +false+
-        # @raise [Plow::SystemUserNameNotFoundError] Raised if the +context.user_name+ is not found 
-        #   even after it has been created
-        def user_home_exists?
-          users do |user|
-            if user[:name] == context.user_name
-              @user_home_path = user[:home_path]
-              return Dir.exists?(user[:home_path])
-            end
-          end
-          
-          raise(Plow::SystemUserNameNotFoundError, context.user_name)
-        end
-        
-        ##
-        # Creates a +user_home_path+
-        def create_user_home
-          shell <<-RUN
-            mkdir #{user_home_path}
-            chown #{context.user_name}:#{context.user_name} #{user_home_path}
-          RUN
-        end
-        
-        ############################################################################################################
-        
-        ##
-        # Determines if the +sites_home_path+ already exists.  As a side-effect, also correctly
-        #   sets the +@sites_home_path+ variable.
-        # @return [Boolean] +true+ if the path already exists, otherwise +false+
-        def sites_home_exists?
-          @sites_home_path = "#{user_home_path}/sites"
-          Dir.exists?(sites_home_path)
-        end
-        
-        ##
-        # Creates the +site_home_path+
-        def create_sites_home
-          shell <<-RUN
-            mkdir #{sites_home_path}
-            chown #{context.user_name}:#{context.user_name} #{sites_home_path}
-          RUN
-        end
-        
-        ############################################################################################################
-        
-        ##
-        # Determines if the +app_root_path+ already exists.  As a side-effect, also correctly
-        #   sets the +@app_root_path+ variable.
-        # @return [Boolean] +true+ if the path exists, otherwise +false+
-        def app_root_exists?
-          @app_root_path = "#{sites_home_path}/#{context.site_name}"
-          Dir.exists?(app_root_path)
-        end
-        
-        ##
-        # Creates the +app_root_path+
-        def create_app_root
-          shell <<-RUN
-            mkdir #{app_root_path}
-            chown #{context.user_name}:#{context.user_name} #{app_root_path}
-          RUN
-        end
-        
-        ############################################################################################################
-        
-        ##
-        # Creates the app public structure at +app_public_path+
-        def create_app_public
-          shell <<-RUN
-            mkdir #{app_public_path}
-            touch #{app_public_path}/index.html
-            chown -R #{context.user_name}:#{context.user_name} #{app_public_path}
-          RUN
-        end
-        
-        ############################################################################################################
-        
-        ##
-        # Creates the app log structure at +app_log_path+
-        def create_app_logs
-          shell <<-RUN
-            mkdir #{app_log_path}
-            mkdir #{app_log_path}/apache2
-            chmod 750 #{app_log_path}/apache2
-            
-            touch #{app_log_path}/apache2/access.log
-            touch #{app_log_path}/apache2/error.log
-            
-            chmod 640 #{app_log_path}/apache2/*.log
-            chown -R #{context.user_name}:#{context.user_name} #{app_log_path}
-            chown root -R #{app_log_path}/apache2
-          RUN
-        end
-        
-        ############################################################################################################
-        
-        ##
-        # Determines if the apache2 vhost config file already exists
-        # @return [Boolean] +true+ if the file exists, otherwise +false+
-        def vhost_config_exists?
-          Dir.exists?(vhost_file_path)
-        end
-        
-        ##
-        # Creates an apache2 vhost config file from a template file to a +vhost_file_path+
-        def create_vhost_config
-          File.open(vhost_file_path, 'wt') do |file|
-            template_context = {
-              :site_name       => context.site_name,
-              :site_aliases    => context.site_aliases,
-              :app_public_path => app_public_path,
-              :app_log_path    => app_log_path
-            }
-            
-            config = context.evaluate_template(vhost_template_file_path, template_context)
-            file.write(config)
-          end
-        end
-        
-        ############################################################################################################
-        
-        ##
-        # Installs the apache2 vhost config file by enabling the site and restarting the web server
-        def install_vhost_config
-          shell <<-RUN
-            a2ensite #{vhost_file_name}
-            apache2ctl graceful
-          RUN
-        end
-      end
-      
-    end
-  end
-end