jiraSOAP 0.6.1 → 0.7.1

data/lib/jiraSOAP/url.rb

@@ -1,30 +1,19 @@
-# A bit of a hack to support using an NSURL in MacRuby while still supporting
-# MRI by using the URI module.
-#
-# For any JIRA entity that has a URL object as an instance variable, you can
-# stick whatever type of object you want in the instance varible, as long as
-# the object has a #to_s method that returns a properly formatted URI.
-class URL
+module JIRA
 
-  # @return [NSURL, URI::HTTP] the type depends on your RUBY_ENGINE
-  attr_accessor :url
+  class << self
 
-  # Initializes @url with the correct object type.
-  # @param [String] url string to turn into some kind of URL object
-  # @return [URI::HTTP,NSURL] URI::HTTP on CRuby, NSURL on MacRuby
-  def initialize(url)
-    @url = URI.parse url
-  end
+    # Normally this variable is set to URI, but with MacRuby it is
+    # set to NSURL
+    # @return [Class,Module]
+    attr_accessor :url_class
 
-  # The #to_s method technically exists and so method_missing would not
-  # work its magic to redirect it to @url so we manually override.
-  # @return [String]
-  def to_s
-    @url.to_s
-  end
+    # We also need a variable for the init method for a URL object
+    # @return [Symbol]
+    attr_accessor :url_init_method
 
-  # The magic of the hack, passing everything to the level beneath.
-  def method_missing(method, *args)
-    @url.send method, *args
   end
+
+  @url_class       = URI
+  @url_init_method = :parse
+
 end

data/yard-jiraSOAP.rb

@@ -0,0 +1,65 @@
+class MyAttributeHandler < YARD::Handlers::Ruby::AttributeHandler
+  handles method_call(:add_attributes)
+  namespace_only # just to be safe
+
+  # @return [Hash{Symbol=>String}] convert a parse method to an object type
+  CONVERT_TABLE = {
+              to_s:'String',
+              to_i:'Fixnum',
+           to_date:'Time',
+        to_boolean:'Boolean',
+             to_ss:'Array<String>',
+         to_object:'PROBLEM?', #' emacs ruby-mode fail
+        to_objects:'Array<PROBLEM?>',
+            to_url:'URI::HTTP,NSURL',
+    to_date_string:'String',
+     to_hex_string:'String'
+  }
+
+  process do
+    return if statement.class == YARD::Parser::Ruby::ReferenceNode # no args
+
+    statement.parameters.each { |array|
+      next if array == false
+      entry     = array.first
+      jira_name = entry[0].jump(:tstring_content).source
+      name      = entry[1].jump(:ident).source
+      # @todo fix the back-pedaling (Symbol->String->Symbol)
+      type      = CONVERT_TABLE[entry[2].jump(:ident).source.to_sym]
+      if type.match /PROBLEM\?/
+        type_ext = []
+        entry[-1].traverse { |node|
+          type_ext << node.source if node.type == :const
+        }
+        type.sub! /PROBLEM\?/, type_ext.join('::')
+      end
+
+      read_object  = make_method name, type, jira_name, array.docstring
+      write_object = make_method "#{name}=", type, jira_name, array.docstring
+      if type == 'Boolean'
+        truth_object = make_method "#{name}?", type, jira_name, array.docstring
+      end
+
+      namespace.attributes[:instance][name] = { read:read_object, write:write_object }
+    }
+  end
+
+  # @param [String] name
+  # @param [String] type
+  # @param [String] jira_name
+  # @param [String] docstring
+  # @return [YARD::CodeObjects::MethodObject]
+  def make_method name, type, jira_name, docstring
+    object = YARD::CodeObjects::MethodObject.new(namespace, name, :instance)
+    object.dynamic  = true
+    object.explicit = false
+    object['generator'] = 'Generated by #add_attributes'
+
+    object.docstring = "Corresponds to `#{jira_name}` in the javadoc."
+    object.docstring += "\n\n#{docstring}" if docstring
+    object.docstring += '.' unless object.docstring[-1] == '.'
+    object.docstring.add_tag(YARD::Tags::Tag.new(:return, "", type))
+    object
+  end
+
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: jiraSOAP
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 6
-  - 1
-  version: 0.6.1
+  prerelease: 
+  version: 0.7.1
 platform: ruby
 authors: 
 - Mark Rada
@@ -14,159 +10,124 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-31 00:00:00 -05:00
+date: 2011-02-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 4
         version: 1.4.4
   type: :runtime
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: handsoap
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+        version: 1.1.8
   type: :runtime
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: minitest
+  name: rake
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 0
-        version: 2.0.0
+        version: 0.8.7
   type: :development
-  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: bundler
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 0
-        version: 0.6.0
+        version: 1.0.10
   type: :development
-  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: bluecloth
+  name: minitest
+  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 0
-        version: 2.0.0
+        version: 2.0.2
   type: :development
-  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: yardstick
+  name: reek
+  prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 2
-        - 0
-        version: 0.2.0
+        version: 1.2.8
   type: :development
-  prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: yard
+  prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+        version: 0.6.4
   type: :development
-  prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: bluecloth
+  prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
+        version: 2.0.10
   type: :development
-  prerelease: false
   version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: reek
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 0
-        version: 1.2.0
-  type: :development
-  prerelease: false
-  version_requirements: *id009
 description: Written to run fast and work on Ruby 1.9 as well as MacRuby
-email: mrada@marketcircle.com
+email: 
+- mrada@marketcircle.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - ChangeLog
-- LICENSE
+- LICENSE.txt
 - README.markdown
+- .yardopts
 files: 
-- lib/jiraSOAP.rb
-- lib/jiraSOAP/JIRAservice.rb
+- lib/jiraSOAP/api/additions.rb
+- lib/jiraSOAP/api/attachments.rb
+- lib/jiraSOAP/api/avatars.rb
+- lib/jiraSOAP/api/comments.rb
+- lib/jiraSOAP/api/filters.rb
+- lib/jiraSOAP/api/issue_data_types.rb
+- lib/jiraSOAP/api/issues.rb
+- lib/jiraSOAP/api/project_roles.rb
+- lib/jiraSOAP/api/projects.rb
+- lib/jiraSOAP/api/schemes.rb
+- lib/jiraSOAP/api/server_info.rb
+- lib/jiraSOAP/api/users.rb
+- lib/jiraSOAP/api/versions.rb
 - lib/jiraSOAP/api.rb
-- lib/jiraSOAP/api/convenience.rb
-- lib/jiraSOAP/entities.rb
 - lib/jiraSOAP/entities/attachment_metadata.rb
 - lib/jiraSOAP/entities/avatar.rb
 - lib/jiraSOAP/entities/comment.rb
@@ -190,7 +151,6 @@ files:
 - lib/jiraSOAP/entities/priority.rb
 - lib/jiraSOAP/entities/project.rb
 - lib/jiraSOAP/entities/project_role.rb
-- lib/jiraSOAP/entities/remote_entity.rb
 - lib/jiraSOAP/entities/resolution.rb
 - lib/jiraSOAP/entities/scheme.rb
 - lib/jiraSOAP/entities/server_configuration.rb
@@ -198,19 +158,25 @@ files:
 - lib/jiraSOAP/entities/status.rb
 - lib/jiraSOAP/entities/time_info.rb
 - lib/jiraSOAP/entities/user.rb
+- lib/jiraSOAP/entities/username.rb
 - lib/jiraSOAP/entities/version.rb
+- lib/jiraSOAP/entities.rb
 - lib/jiraSOAP/handsoap_extensions.rb
+- lib/jiraSOAP/JIRAservice.rb
 - lib/jiraSOAP/macruby_bonuses.rb
 - lib/jiraSOAP/url.rb
+- lib/jiraSOAP.rb
+- yard-jiraSOAP.rb
 - ChangeLog
-- LICENSE
+- LICENSE.txt
 - README.markdown
+- .yardopts
 - test/jiraSOAP_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/Marketcircle/jiraSOAP
-licenses: []
-
+licenses: 
+- - MIT
 post_install_message: 
 rdoc_options: []
 
@@ -221,23 +187,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ~>
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 9
-      - 2
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: A Ruby client for the JIRA SOAP API

data/lib/jiraSOAP/api/convenience.rb

@@ -1,12 +0,0 @@
-module RemoteAPIAdditions
-
-  # Returns nil if the field is not found.
-  # @param [String] name
-  # @return [JIRA::Field,nil]
-  def get_custom_field_with_name name
-    get_custom_fields.each { |cf|
-      return cf if cf.name == name
-    }
-    nil
-  end
-end

data/lib/jiraSOAP/entities/remote_entity.rb

@@ -1,7 +0,0 @@
-# This is just a @name, JIRA::User should inherit from this class
-class JIRA::RemoteEntity < JIRA::Entity
-  add_attributes({ 'name' => [:name=, :to_s] })
-
-  # @return [String]
-  attr_accessor :name
-end