gooddata 0.6.0.pre9 → 0.6.0.pre10

data/doc/templates/default/module/dot/setup.rb

@@ -0,0 +1,14 @@
+def init
+  @modules = object.children.select {|o| o.type == :module }
+  @classes = object.children.select {|o| o.type == :class }
+  sections :child, [:info], :classes, [T('class')], :header, [T('module')], :dependencies
+end
+
+def dependencies
+  return unless options.dependencies
+  erb(:dependencies)
+end
+
+def classes
+  @classes.map {|k| yieldall :object => k }.join("\n")
+end

data/doc/templates/default/module/setup.rb

@@ -0,0 +1,164 @@
+include Helpers::ModuleHelper
+
+def init
+  sections :header, :box_info, :pre_docstring, T('docstring'), :children,
+    :constant_summary, [T('docstring')], :inherited_constants,
+    :attribute_summary, [:item_summary], :inherited_attributes,
+    :method_summary, [:item_summary], :inherited_methods,
+    :methodmissing, [T('method_details')],
+    :attribute_details, [T('method_details')],
+    :method_details_list, [T('method_details')]
+end
+
+def pre_docstring
+  return if object.docstring.blank?
+  erb(:pre_docstring)
+end
+
+def children
+  @inner = [[:modules, []], [:classes, []]]
+  object.children.each do |child|
+    @inner[0][1] << child if child.type == :module
+    @inner[1][1] << child if child.type == :class
+  end
+  @inner.map! {|v| [v[0], run_verifier(v[1].sort_by {|o| o.name.to_s })] }
+  return if (@inner[0][1].size + @inner[1][1].size) == 0
+  erb(:children)
+end
+
+def methodmissing
+  mms = object.meths(:inherited => true, :included => true)
+  return unless @mm = mms.find {|o| o.name == :method_missing && o.scope == :instance }
+  erb(:methodmissing)
+end
+
+def method_listing(include_specials = true)
+  return @smeths ||= method_listing.reject {|o| special_method?(o) } unless include_specials
+  return @meths if @meths
+  @meths = object.meths(:inherited => false, :included => !options.embed_mixins.empty?)
+  if options.embed_mixins.size > 0
+    @meths = @meths.reject {|m| options.embed_mixins_match?(m.namespace) == false }
+  end
+  @meths = sort_listing(prune_method_listing(@meths))
+  @meths
+end
+
+def special_method?(meth)
+  return true if meth.name(true) == '#method_missing'
+  return true if meth.constructor?
+  false
+end
+
+def attr_listing
+  return @attrs if @attrs
+  @attrs = []
+  object.inheritance_tree(true).each do |superclass|
+    next if superclass.is_a?(CodeObjects::Proxy)
+    next if options.embed_mixins.size > 0 &&
+      options.embed_mixins_match?(superclass) == false
+    [:class, :instance].each do |scope|
+      superclass.attributes[scope].each do |name, rw|
+        attr = prune_method_listing([rw[:read], rw[:write]].compact, false).first
+        @attrs << attr if attr
+      end
+    end
+    break if options.embed_mixins.empty?
+  end
+  @attrs = sort_listing(@attrs)
+end
+
+def constant_listing
+  return @constants if @constants
+  @constants = object.constants(:included => false, :inherited => false)
+  @constants += object.cvars
+  @constants = run_verifier(@constants)
+  @constants
+end
+
+def sort_listing(list)
+  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
+end
+
+def inherited_attr_list(&block)
+  object.inheritance_tree(true)[1..-1].each do |superclass|
+    next if superclass.is_a?(YARD::CodeObjects::Proxy)
+    next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false
+    attribs = superclass.attributes[:instance]
+    attribs = attribs.reject {|name, rw| object.child(:scope => :instance, :name => name) != nil }
+    attribs = attribs.sort_by {|args| args.first.to_s }.map {|n, m| m[:read] || m[:write] }
+    attribs = prune_method_listing(attribs, false)
+    yield superclass, attribs if attribs.size > 0
+  end
+end
+
+def inherited_constant_list(&block)
+  object.inheritance_tree(true)[1..-1].each do |superclass|
+    next if superclass.is_a?(YARD::CodeObjects::Proxy)
+    next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false
+    consts = superclass.constants(:included => false, :inherited => false)
+    consts = consts.reject {|const| object.child(:type => :constant, :name => const.name) != nil }
+    consts = consts.sort_by {|const| const.name.to_s }
+    consts = run_verifier(consts)
+    yield superclass, consts if consts.size > 0
+  end
+end
+
+def docstring_full(obj)
+  docstring = ""
+  if obj.tags(:overload).size == 1 && obj.docstring.empty?
+    docstring = obj.tag(:overload).docstring
+  else
+    docstring = obj.docstring
+  end
+
+  if docstring.summary.empty? && obj.tags(:return).size == 1 && obj.tag(:return).text
+    docstring = Docstring.new(obj.tag(:return).text.gsub(/\A([a-z])/) {|x| x.upcase }.strip)
+  end
+
+  docstring
+end
+
+def docstring_summary(obj)
+  docstring_full(obj).summary
+end
+
+def groups(list, type = "Method")
+  if groups_data = object.groups
+    list.each {|m| groups_data |= [m.group] if m.group && owner != m.namespace }
+    others = list.select {|m| !m.group || !groups_data.include?(m.group) }
+    groups_data.each do |name|
+      items = list.select {|m| m.group == name }
+      yield(items, name) unless items.empty?
+    end
+  else
+    others = []
+    group_data = {}
+    list.each do |meth|
+      if meth.group
+        (group_data[meth.group] ||= []) << meth
+      else
+        others << meth
+      end
+    end
+    group_data.each {|group, items| yield(items, group) unless items.empty? }
+  end
+
+  scopes(others) {|items, scope| yield(items, "#{scope.to_s.capitalize} #{type} Summary") }
+end
+
+def scopes(list)
+  [:class, :instance].each do |scope|
+    items = list.select {|m| m.scope == scope }
+    yield(items, scope) unless items.empty?
+  end
+end
+
+def mixed_into(object)
+  unless globals.mixed_into
+    globals.mixed_into = {}
+    list = run_verifier Registry.all(:class, :module)
+    list.each {|o| o.mixins.each {|m| (globals.mixed_into[m.path] ||= []) << o } }
+  end
+
+  globals.mixed_into[object.path] || []
+end

data/doc/templates/default/module/text/children.erb

@@ -0,0 +1,10 @@
+Defined Under Namespace:
+------------------------
+
+<% @inner.each do |name, list| %>
+<% if list.size > 0 %>
+<% text = list.map {|c| c.name }.join(", ") + " (#{name})" %>
+<%= indent(wrap(text)) %>
+
+<% end %>
+<% end %>

data/doc/templates/default/module/text/class_meths_list.erb

@@ -0,0 +1,8 @@
+<% if class_meths.size > 0 %>
+Class methods:
+--------------
+
+<%= indent wrap(class_meths.map {|o| o.name.to_s }.join(", "), 68) %>
+
+
+<% end %>

data/doc/templates/default/module/text/extends.erb

@@ -0,0 +1,8 @@
+<% if object.mixins(:class).size > 0 %>
+Extended by:
+------------
+
+<%= indent wrap(object.mixins(:class).join(", "), 68) %>
+
+
+<% end %>

data/doc/templates/default/module/text/header.erb

@@ -0,0 +1,7 @@
+<%= title_align_right format_object_title(object) %>
+
+<%= yieldall %>
+
+<%= hr %>
+
+

data/doc/templates/default/module/text/includes.erb

@@ -0,0 +1,8 @@
+<% if object.mixins(:instance).size > 0 %>
+Includes:
+---------
+
+<%= indent wrap(object.mixins(:instance).join(", "), 68) %>
+
+
+<% end %>

data/doc/templates/default/module/text/instance_meths_list.erb

@@ -0,0 +1,8 @@
+<% if instance_meths.size > 0 %>
+Instance methods:
+-----------------
+
+<%= indent wrap(instance_meths.map {|o| o.name.to_s }.join(", "), 68) %>
+
+
+<% end %>

data/doc/templates/default/module/text/setup.rb

@@ -0,0 +1,12 @@
+def init
+  sections :header, [T('docstring')], :children, :includes, :extends,
+    :class_meths_list, :instance_meths_list
+end
+
+def class_meths
+  @classmeths ||= method_listing.select {|o| o.scope == :class }
+end
+
+def instance_meths
+  @instmeths ||= method_listing.select {|o| o.scope == :instance }
+end

data/doc/templates/default/root/dot/child.erb

@@ -0,0 +1,3 @@
+<% if inner = yieldall.gsub("\n", '') %>
+Root [label="{<%= inner %>}" rank=sink];
+<% end %>

data/doc/templates/default/root/dot/setup.rb

@@ -0,0 +1,5 @@
+include T('default/module/dot')
+
+def format_path(object)
+  ""
+end

data/doc/templates/default/tags/setup.rb

@@ -0,0 +1,55 @@
+def init
+  tags = Tags::Library.visible_tags - [:abstract, :deprecated, :note, :todo]
+  create_tag_methods(tags - [:example, :option, :overload, :see])
+  sections :index, tags.map {|t| t.to_s.gsub('.', '_').to_sym }
+  sections.any(:overload).push(T('docstring'))
+end
+
+def return
+  if object.type == :method
+    return if object.constructor?
+    return if object.tags(:return).size == 1 && object.tag(:return).types == ['void']
+  end
+  tag(:return)
+end
+
+def param
+  tag(:param) if object.type == :method
+end
+
+private
+
+def tag(name, opts = nil)
+  return unless object.has_tag?(name)
+  opts ||= options_for_tag(name)
+  @no_names = true if opts[:no_names]
+  @no_types = true if opts[:no_types]
+  @name = name
+  out = erb('tag')
+  @no_names, @no_types = nil, nil
+  out
+end
+
+def create_tag_methods(tags)
+  tags.each do |tag|
+    tag_meth = tag.to_s.gsub('.', '_')
+    next if respond_to?(tag_meth)
+    instance_eval(<<-eof, __FILE__, __LINE__ + 1)
+      def #{tag_meth}; tag(#{tag.inspect}) end
+    eof
+  end
+end
+
+def options_for_tag(tag)
+  opts = {:no_types => true, :no_names => true}
+  case Tags::Library.factory_method_for(tag)
+  when :with_types
+    opts[:no_types] = false
+  when :with_types_and_name
+    opts[:no_types] = false
+    opts[:no_names] = false
+  when :with_name
+    opts[:no_names] = false
+  end
+  opts
+end

data/doc/templates/default/tags/text/example.erb

@@ -0,0 +1,12 @@
+<% if object.has_tag?(:example) %>
+
+Examples:
+---------
+
+<% object.tags(:example).each_with_index do |tag, i| %>
+<%= indent("# " + tag.name + "\n") if tag.name %>
+<%= indent(format_source(tag.text)) + "\n" %>
+<%= "\n" if i < object.tags(:example).size - 1 %>
+<% end %>
+<% end %>
+

data/doc/templates/default/tags/text/index.erb

@@ -0,0 +1 @@
+<%= yieldall %>

data/doc/templates/default/tags/text/option.erb

@@ -0,0 +1,20 @@
+<% if object.has_tag?(:option) %>
+<% object.parameters.each do |param, default| %>
+<% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s } %>
+<% next if tags.empty? %>
+Options Hash (<%= param %>):
+--------------<%= hr(param.to_s.length) %>--
+
+<% for tag in tags %>
+<% text = "" %>
+<% text += format_types(tag.pair.types || ['Object']) %>
+<% text += " " + tag.pair.name.to_s %>
+<% if tag.pair.defaults %>
+<% text += " - default: " + tag.pair.defaults.join(", ") %>
+<% end %>
+<% text += " - " + tag.pair.text if tag.pair.text %>
+<%= indent(wrap(text)) %>
+
+<% end %>
+<% end %>
+<% end %>

data/doc/templates/default/tags/text/overload.erb

@@ -0,0 +1,19 @@
+<% if object.tags(:overload).size == 1 %>
+<%= wrap(yieldall(:object => object.tag(:overload))) %>
+<% elsif object.has_tag?(:overload) %>
+Overloads:
+----------
+
+<% object.tags(:overload).each do |overload| %>
+<% if overload.tags.size > 0 %>
+<%= hr %>
+
+<%= indent signature(overload) %>
+
+<%= hr %>
+
+<%= indent(wrap(yieldall(:object => overload))) %>
+
+<% end %>
+<% end %>
+<% end %>

data/doc/templates/default/tags/text/see.erb

@@ -0,0 +1,11 @@
+<% if object.has_tag?(:see) %>
+See Also:
+---------
+
+<% for tag in object.tags(:see) %>
+<% text = "- " + tag.name %>
+<% text += " - " + tag.text if tag.text && !tag.text.empty? %>
+<%= indent(wrap(text)) %>
+<% end %>
+<% end %>
+

data/doc/templates/default/tags/text/tag.erb

@@ -0,0 +1,13 @@
+<% title = @label ? @label : YARD::Tags::Library.labels[@name] %>
+<%= title %>:
+<%= hr(title.length) %>-
+
+<% object.tags(@name).each do |tag| %>
+<% text = "" %>
+<% text += format_types(tag.types) + " " unless @no_types || tag.types.nil? %>
+<% text += tag.name.to_s + " " unless @no_names %>
+<% text += "- " unless @no_names && @no_types %>
+<% text += tag.text if tag.text && !tag.text.empty? %>
+<%= indent wrap(text) %>
+
+<% end %>

data/examples.rb

@@ -40,12 +40,12 @@ Dataset['dataset.test'].load 'data.csv'
 p1.datasets['dataset.test'].load GoodData::Source::CsvFile.new 'data.csv'
 
 # Populate a data set from the result of a SalesForce query
-Dataset['dataset.test'].load GoodData::Source::SalesForce.new {
+Dataset['dataset.test'].load GoodData::Source::SalesForce.new({
   :username => "test@example.org",
   :password => "blahblah",
   :key => "mkjlnlkh845n4lhasdsdagddddddfa",
   :query => "SELECT Id, Name FROM Account"
-}
+})
 
 # Get a representation of a specific project
 p1 = Project['afawtv356b6usdfsdf34vt']

data/gooddata.gemspec

@@ -1,6 +1,3 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib/", __FILE__)
 require "gooddata/version"
@@ -8,40 +5,48 @@ require "gooddata/version"
 Gem::Specification.new do |s|
   s.name = %q{gooddata}
   s.version = GoodData::VERSION
-  
+  s.licenses = ['BSD']
+
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Pavel Kolesnikov", "Thomas Watson Steen"]
+  s.authors = [
+      "Pavel Kolesnikov",
+      "Thomas Watson Steen"
+  ]
+
   s.summary = %q{A convenient Ruby wrapper around the GoodData RESTful API}
   s.date = %q{2012-12-17}
   s.description = %q{Use the GoodData::Client class to integrate GoodData into your own application or use the CLI to work with GoodData directly from the command line.}
   s.email = %q{pavel@gooddata.com}
   s.executables = ["gooddata"]
   s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
+      "LICENSE",
+      "README.md"
   ]
   s.files = `git ls-files`.split($/)
   s.homepage = %q{http://github.com/gooddata/gooddata-ruby}
   s.require_paths = ["lib"]
   s.rubygems_version = "1.3.7"
-  
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
 
-  s.add_dependency "bundler"
-  s.add_dependency "parseconfig"
-  s.add_dependency "json_pure"
-  s.add_dependency "rest-client"
-  s.add_dependency "json"
-  s.add_dependency "rubyzip"
-  s.add_dependency "highline"
-  s.add_dependency "gli"
-  s.add_dependency "pry"
-  s.add_dependency "erubis"
-  s.add_dependency "activesupport"
-  s.add_dependency "restforce"
-  s.add_dependency "salesforce_bulk"
-#  s.add_dependency "twitter"
-  
-end
+  s.add_development_dependency "rake", "~> 10.1.1"
+  s.add_development_dependency "redcarpet", "~> 3.1.1"
+  s.add_development_dependency "rspec", "~> 2.14.1"
+  s.add_development_dependency "simplecov", "~> 0.8.2"
+  s.add_development_dependency "yard", "~> 0.8.7.3"
+  s.add_development_dependency "yard-rspec", "~> 0.1"
 
+  s.add_dependency "activesupport", "~> 4.0.3"
+  s.add_dependency "bundler", "~> 1.5.3"
+  s.add_dependency "erubis", "~> 2.7.0"
+  s.add_dependency "gli", "~> 2.9.0"
+  s.add_dependency "highline", "~> 1.6.21"
+  s.add_dependency "i18n", "~> 0.6.9"
+  s.add_dependency "json", "~> 1.8.1"
+  s.add_dependency "json_pure", "~> 1.8.1"
+  s.add_dependency "multi_json", "~> 1.9.0"
+  s.add_dependency "parseconfig", "~> 1.0.4"
+  s.add_dependency "pry", "~> 0.9.12.6"
+  s.add_dependency "restforce", "~> 1.4.3"
+  s.add_dependency "rest-client", "~> 1.6.7"
+  s.add_dependency "rubyzip", "~> 1.1.0"
+  s.add_dependency "salesforce_bulk", "~> 1.0.3"
+end