wpb 0.0.3 → 0.0.5

data/lib/wpb/clamp/option/declaration.rb

@@ -0,0 +1,58 @@
+require 'clamp/attribute_declaration'
+require 'clamp/option'
+
+module Clamp
+  class Option
+
+    module Declaration
+
+      include Clamp::AttributeDeclaration
+
+      def option(switches, type, description, opts = {}, &block)
+        option = Clamp::Option.new(switches, type, description, opts)
+        declared_options << option
+        define_accessors_for(option, &block)
+      end
+
+      def has_options?
+        !documented_options.empty?
+      end
+
+      def find_option(switch)
+        recognised_options.find { |o| o.handles?(switch) }
+      end
+
+      def declared_options
+        @declared_options ||= []
+      end
+
+      def documented_options
+        declared_options + inherited_declared_options
+      end
+
+      def recognised_options
+        documented_options + standard_options
+      end
+
+      private
+
+      def inherited_declared_options
+        ancestors.inject([]) do |options, ancestor| 
+          if ancestor.kind_of?(Clamp::Option::Declaration)
+            options + ancestor.declared_options
+          else
+            options
+          end
+        end
+      end
+
+      HELP_OPTION = Clamp::Option.new("--help", :flag, "print help", :attribute_name => :help_requested)
+
+      def standard_options
+        [HELP_OPTION]
+      end
+
+    end
+
+  end
+end

data/lib/wpb/clamp/option/parsing.rb

@@ -0,0 +1,45 @@
+module Clamp
+  class Option
+
+    module Parsing
+
+      protected
+
+      def parse_options
+        while remaining_arguments.first =~ /^-/
+
+          switch = remaining_arguments.shift
+          break if switch == "--"
+
+          case switch
+          when /^(-\w)(.+)$/ # combined short options
+            switch = $1
+            remaining_arguments.unshift("-#{$2}")
+          when /^(--[^=]+)=(.*)/
+            switch = $1
+            remaining_arguments.unshift($2)
+          end
+            
+          option = find_option(switch)
+          value = option.extract_value(switch, remaining_arguments)
+
+          begin
+            send("#{option.attribute_name}=", value)
+          rescue ArgumentError => e
+            signal_usage_error "option '#{switch}': #{e.message}"
+          end
+
+        end
+      end
+
+      private
+
+      def find_option(switch)
+        self.class.find_option(switch) || 
+        signal_usage_error("Unrecognised option '#{switch}'")
+      end
+
+    end
+
+  end
+end

data/lib/wpb/clamp/parameter.rb

@@ -0,0 +1,70 @@
+require 'clamp/attribute'
+
+module Clamp
+
+  class Parameter < Attribute
+
+    def initialize(name, description, options = {})
+      @name = name
+      @description = description
+      infer_attribute_name_and_multiplicity
+      if options.has_key?(:attribute_name)
+        @attribute_name = options[:attribute_name].to_s 
+      end
+      if options.has_key?(:default)
+        @default_value = options[:default]
+      end
+    end
+
+    attr_reader :name, :attribute_name
+    
+    def help_lhs
+      name
+    end
+
+    def consume(arguments)
+      if required? && arguments.empty?
+        raise ArgumentError, "no value provided"
+      end
+      if multivalued?
+        arguments.shift(arguments.length)
+      else
+        arguments.shift
+      end
+    end
+    
+    private
+
+    NAME_PATTERN = "([A-Za-z0-9_-]+)"
+    
+    def infer_attribute_name_and_multiplicity
+      case @name
+      when /^\[#{NAME_PATTERN}\]$/
+        @attribute_name = $1
+      when /^\[#{NAME_PATTERN}\] ...$/
+        @attribute_name = "#{$1}_list"
+        @multivalued = true
+      when /^#{NAME_PATTERN} ...$/
+        @attribute_name = "#{$1}_list"
+        @multivalued = true
+        @required = true
+      when /^#{NAME_PATTERN}$/
+        @attribute_name = @name
+        @required = true
+      else
+        raise "invalid parameter name: '#{name}'"
+      end
+      @attribute_name = @attribute_name.downcase.tr('-', '_')
+    end
+    
+    def multivalued?
+      @multivalued
+    end
+
+    def required?
+      @required
+    end
+    
+  end
+
+end

data/lib/wpb/clamp/parameter/declaration.rb

@@ -0,0 +1,28 @@
+require 'clamp/attribute_declaration'
+require 'clamp/parameter'
+
+module Clamp
+  class Parameter
+
+    module Declaration
+
+      include Clamp::AttributeDeclaration
+
+      def parameters
+        @parameters ||= []
+      end
+
+      def has_parameters?
+        !parameters.empty?
+      end
+
+      def parameter(name, description, options = {}, &block)
+        parameter = Parameter.new(name, description, options)
+        parameters << parameter
+        define_accessors_for(parameter, &block)
+      end
+
+    end
+
+  end
+end

data/lib/wpb/clamp/parameter/parsing.rb

@@ -0,0 +1,28 @@
+module Clamp
+  class Parameter
+
+    module Parsing
+
+      protected
+      
+      def parse_parameters
+
+        self.class.parameters.each do |parameter|
+          begin
+            value = parameter.consume(remaining_arguments)
+            send("#{parameter.attribute_name}=", value) unless value.nil?
+          rescue ArgumentError => e
+            signal_usage_error "parameter '#{parameter.name}': #{e.message}"
+          end
+        end
+
+        unless remaining_arguments.empty?
+          signal_usage_error "too many arguments"
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/wpb/clamp/subcommand.rb

@@ -0,0 +1,23 @@
+module Clamp
+
+  class Subcommand < Struct.new(:name, :description, :subcommand_class)
+
+    def initialize(names, description, subcommand_class)
+      @names = Array(names)
+      @description = description
+      @subcommand_class = subcommand_class
+    end
+
+    attr_reader :names, :description, :subcommand_class
+
+    def is_called?(name)
+      names.member?(name)
+    end
+
+    def help
+      [names.join(", "), description]
+    end
+
+  end
+
+end

data/lib/wpb/clamp/subcommand/declaration.rb

@@ -0,0 +1,40 @@
+require 'clamp/subcommand'
+
+module Clamp
+  class Subcommand
+
+    module Declaration
+
+      def recognised_subcommands
+        @recognised_subcommands ||= []
+      end
+
+      def subcommand(name, description, subcommand_class = self, &block)
+        has_subcommands!
+        if block
+          # generate a anonymous sub-class
+          subcommand_class = Class.new(subcommand_class, &block)
+        end
+        recognised_subcommands << Subcommand.new(name, description, subcommand_class)
+      end
+
+      def has_subcommands?
+        !recognised_subcommands.empty?
+      end
+
+      def find_subcommand(name)
+        recognised_subcommands.find { |sc| sc.is_called?(name) }
+      end
+      
+      def has_subcommands!
+        unless @has_subcommands
+          parameter "[SUBCOMMAND]", "subcommand name", :attribute_name => :subcommand_name
+          parameter "[ARGS] ...", "subcommand arguments", :attribute_name => :subcommand_arguments
+          @has_subcommands = true
+        end
+      end
+
+    end
+
+  end
+end

data/lib/wpb/clamp/subcommand/execution.rb

@@ -0,0 +1,37 @@
+module Clamp
+  class Subcommand
+
+    module Execution
+
+      protected
+      
+      def execute_subcommand
+				if subcommand_name
+        	subcommand_class = find_subcommand_class(subcommand_name)
+        	subcommand = subcommand_class.new("#{invocation_path} #{subcommand_name}", context)
+        	self.class.recognised_options.each do |option|
+        	  option_set = instance_variable_defined?(option.ivar_name)
+        	  if option_set && subcommand.respond_to?(option.write_method)
+        	    subcommand.send(option.write_method, self.send(option.read_method))
+        	  end
+        	end
+        	subcommand.run(subcommand_arguments)
+				end
+      end
+
+      private
+
+      def find_subcommand(name)
+        self.class.find_subcommand(name) || 
+        signal_usage_error("No such sub-command '#{name}'")
+      end
+
+      def find_subcommand_class(name)
+        subcommand = find_subcommand(name)
+        subcommand.subcommand_class if subcommand
+      end
+
+    end
+
+  end
+end

data/lib/wpb/clamp/version.rb

@@ -0,0 +1,3 @@
+module Clamp
+  VERSION = "0.1.9.dev".freeze
+end

data/lib/wpb/comment.rb

@@ -1,5 +1,44 @@
 require "active_record"
 
+##
+# This class is used for getting the comments from the wordpress database
+# 
+# == Examples:
+#   User.find(1).comments
+# <em>The above will find the user with id of 1 and retrieve all of the comments they have ever made</em>
+#   Post.find(1).comments
+# <em>The above will find the post with id of 1 and retrieve all of the comments from that post</em>
+#   Comment.find(1)
+# <em>The above will find the comment with id of 1</em>
+# 
+# == Inherited methods
+# [find <em>id</em>]  Retrieves the comment with the sepcified id
+# [all]  Retrieves all of the comments in the database
+# 
+# == Database Keys
+# [comment_ID <em>alias: id</em>] The comments id
+# [comment_post_ID <em>alias: post.id</em>]
+# 	The post id where the comment was posted
+# 	  Comment.find(1).post
+# 	<em>The above returns the Post that the comment belongs to</em>
+# [comment_author] The name of the auther (could be stored in user.name, User#name)
+# [comment_author_email] The email of the author (could be stored in user.email, User#email)
+# [comment_author_url] The url of the author (could be stored in user.url, User#url)
+# [comment_author_IP] The ip of the author
+# [comment_date] The date the comment was posted
+# [comment_date_gmt] The date the comment was posted in gmt/utc time
+# [comment_content <em>alias: Comment#content</em>] The content of the comment
+# [comment_karma] The comment karma
+# [comment_approved] If the comment has been approved or not
+# [comment_agent] The agent of the comment
+# [comment_type] The type of comment
+# [comment_parent] The parent comment id if any
+# [user_id]
+# 	The user id of the author (0 if not registered user)
+# 	  Comment.find(1).user
+# 	<em>The above returns the User that posted the comment if user_id isn't 0</em>
+
+
 class Comment < ActiveRecord::Base
 	set_table_name :wp_comments
 	set_primary_key :comment_ID
@@ -11,17 +50,24 @@ class Comment < ActiveRecord::Base
 	
 	before_create :set_default_values
 	
-	def set_default_values
-		t = Time.now
-		self.comment_date = t
-		self.comment_date_gmt = t.gmtime
-	end
+	##
+	# Grab the content of the selected comment
 	
 	def content
 		comment_content
 	end
 	
+	##
+	# Set the content of the selected comment
+	
 	def content= new_content
 		self.comment_content = new_content
 	end
+	
+	private
+	def set_default_values
+		t = Time.now
+		self.comment_date = t
+		self.comment_date_gmt = t.gmtime
+	end
 end

data/lib/wpb/page.rb

@@ -1,3 +1,49 @@
+##
+# This class is used for getting the pages from the wordpress database
+# 
+# == Examples:
+#   User.find(1).pages
+# <em>The above will find the user with id of 1 and retrieve all of the pages they have ever made</em>
+#   Page.find(1)
+# <em>The above will find the pge with id of 1</em>
+# 
+# == Inherited methods
+# [find <em>id</em>] Retrieves the page with the sepcified id
+# [all] Retrieves all of the pages in the database
+# [title] The title of the page
+# [title= <em>title</em>] Set the title of the page
+# [content] The content of the page
+# [content=] Set the content of the page
+# 
+# == Database Keys
+# [ID <em>alias: id</em>] The pages` id
+# [post_author <em>alias: user.id</em>]
+# 	The User id of who created the Page
+# 	  Page.find(1).user
+# 	<em>The above returns the User that the page belongs to</em>
+# [post_date] The date the page was created
+# [post_date_gmt] The date the page was created in gmt/utc time
+# [post_content <em>alias: PagePost#content</em>] The content of the page
+# [post_title <em>alias: PagePost#title</em>] The title of the page
+# [post_excerpt] The excerpt of the page
+# [post_status] The status of the page <em>e.g. +Published+</em>
+# [comment_status] Whether or not comments are allowed e.g. open
+# [ping_status] Whether or not pings are allowed e.g. open
+# [post_password] The password (if any) required to view the page
+# [post_name] The url version of the page e.g. example-page
+# [to_ping] _Unknown_
+# [pinged] _Unknown_
+# [post_modified] The date the page last edited
+# [post_modified_gmt] The date the page last edited in gmt/utc time
+# [post_content_filtered] _Unknown_
+# [post_parent] The pages parent id (if any)
+# [guid] The full url to the page
+# [menu_order] The order at which the page sits in the menu
+# [post_type] The type of the post e.g. page or post (will always be page)
+# [post_mime_type] The mime type of the post
+# [comment_count] The amount of comments on the page
+# [type] Used and created by wpb for activerecord inheritance
+
 class Page < PagePost
 	belongs_to :user
 end