betterdocs 0.2.0

data/spec/result_representer_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+RSpec.describe Betterdocs::ResultRepresenter do
+  module MySubRepresenter
+    include Betterdocs::ResultRepresenter
+
+    property :some_property
+
+    link 'url3' do
+      url { 'some_url' }
+    end
+  end
+
+  module MyResult
+    include Betterdocs::ResultRepresenter
+
+    property :simple
+
+    property :derived
+
+    property :complex do
+      represent_with MySubRepresenter
+    end
+
+    property :simple_old_name, as: :simple_new_name
+
+    property :derived_old_name, as: :derived_new_name
+
+    property :complex_old_name, as: :complex_new_name do
+      represent_with MySubRepresenter
+    end
+
+    collection :thingies do
+      represent_with MySubRepresenter
+    end
+
+    collection :other_thingies, as: :thingies_new_name do
+      represent_with MySubRepresenter
+    end
+
+    property :if_no, if: -> { no }
+
+    property :unless_yes, unless: -> { yes }
+
+    property :if_predicate, if: -> { simple != 'simple property' }
+
+    property :unless_predicate, unless: -> { simple == 'simple property' }
+
+    link 'url1' do
+      url { 'an_url' }
+    end
+
+    link 'url2' do
+      url { 'another_url' }
+    end
+
+    link 'template' do
+      url { 'an_url_with{placeholder}' }
+      templated true
+    end
+
+    def derived
+      'derived property'
+    end
+
+    def derived_old_name
+      'derived old property'
+    end
+  end
+
+  let :object do
+    OpenStruct.new.tap do |o|
+      o.simple  = 'simple property'
+      o.complex = OpenStruct.new
+      o.complex.some_property = 'some property'
+      o.simple_old_name = 'simple old property'
+      o.complex_old_name = OpenStruct.new
+      o.complex_old_name.some_property = 'some old property'
+      o.thingies = [
+        OpenStruct.new.tap { |t| t.some_property = 'first' },
+        OpenStruct.new.tap { |t| t.some_property = 'second' },
+      ]
+      o.other_thingies = [
+        OpenStruct.new.tap { |t| t.some_property = 'first other' },
+      ]
+      o.if_no = :no
+      o.unless_yes = :yes
+      o.if_predicate = true
+      o.unless_predicate = true
+      MyResult.apply(o)
+    end
+  end
+
+  let :parsed_object do
+    JSON(object.to_json)
+  end
+
+  it 'can be converted into a Hash instance' do
+    expect(object.as_json).to be_a Hash
+    expect(object.as_json).not_to be_empty
+  end
+
+  it 'it can be turned into valid json' do
+    expect(JSON.parse(object.to_json)).to be_a Hash
+  end
+
+  it 'can output pretty json' do
+    expect(JSON.pretty_generate(object)).to include "\n"
+  end
+
+  it 'can output ugly json' do
+    expect(JSON.generate(object)).to_not include "\n"
+  end
+
+  it 'supports simple properties' do
+    expect(parsed_object['simple']).to eq 'simple property'
+  end
+
+  it 'supports derived properties' do
+    expect(parsed_object['derived']).to eq 'derived property'
+  end
+
+  it 'supports complex properties' do
+    expect(parsed_object['complex']['some_property']).to eq 'some property'
+  end
+
+  it 'supports renaming simple properties' do
+    expect(parsed_object['simple_new_name']).to eq 'simple old property'
+  end
+
+  it 'supports renaming derived properties' do
+    expect(parsed_object['derived_new_name']).to eq 'derived old property'
+  end
+
+  it 'supports renaming complex properties' do
+    expect(parsed_object['complex_new_name']['some_property']).to eq 'some old property'
+  end
+
+  it 'supports collections' do
+    expect(parsed_object['thingies'].size).to eq 2
+    expect(parsed_object['thingies'][0]['some_property']).to eq 'first'
+    expect(parsed_object['thingies'][1]['some_property']).to eq 'second'
+  end
+
+  it 'supports renaming collections' do
+    expect(parsed_object['thingies_new_name'].size).to eq 1
+    expect(parsed_object['thingies_new_name'][0]['some_property']).to eq 'first other'
+  end
+
+  it "doesn't crash missing collections" do
+    object.thingies = nil
+    expect(parsed_object['thingies']).to eq []
+  end
+
+  it 'supports links' do
+    links = parsed_object['links']
+    expect(links.size).to eq 3
+    expect(links[0]['rel']).to eq 'url1'
+    expect(links[0]['href']).to eq 'an_url'
+    expect(links[0]).to_not have_key 'templated'
+    expect(links[1]['rel']).to eq 'url2'
+    expect(links[1]['href']).to eq 'another_url'
+    expect(links[1]).to_not have_key 'templated'
+    expect(links[2]['rel']).to eq 'template'
+    expect(links[2]['href']).to eq 'an_url_with{placeholder}'
+    expect(links[2]).to have_key 'templated'
+    expect(links[2]['templated']).to eq true
+  end
+
+  it "doesn't have to have links" do
+    representer = Module.new { include Betterdocs::ResultRepresenter }
+    parsed_object = JSON(representer.apply(object).to_json)
+    expect(parsed_object['links']).to eq []
+  end
+
+  it 'supports conditional properties' do
+    expect(parsed_object['if_no']).to be_nil
+    expect(parsed_object['unless_yes']).to be_nil
+    expect(parsed_object['if_predicate']).to be_nil
+    expect(parsed_object['unless_predicate']).to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+require "codeclimate-test-reporter"
+if ENV['START_SIMPLECOV'].to_i == 1
+  SimpleCov.start do
+    add_filter "#{File.basename(File.dirname(__FILE__))}/"
+  end
+end
+if ENV['CODECLIMATE_REPO_TOKEN']
+  if ENV['START_SIMPLECOV']
+    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      CodeClimate::TestReporter::Formatter
+    ]
+  end
+  CodeClimate::TestReporter.start
+end
+require 'rspec'
+require 'byebug'
+require 'betterdocs'

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: betterdocs
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- betterplace Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_hadar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: This library provides tools to generate API documention for a web site's
+  REST-ful JSON API.
+email: developers@betterplace.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- lib/betterdocs.rb
+- lib/betterdocs/controller_collector.rb
+- lib/betterdocs/dsl.rb
+- lib/betterdocs/dsl/common.rb
+- lib/betterdocs/dsl/controller.rb
+- lib/betterdocs/dsl/controller/action.rb
+- lib/betterdocs/dsl/controller/action/param.rb
+- lib/betterdocs/dsl/controller/action/response.rb
+- lib/betterdocs/dsl/controller/controller.rb
+- lib/betterdocs/dsl/controller/controller_base.rb
+- lib/betterdocs/dsl/json_params.rb
+- lib/betterdocs/dsl/json_params/param.rb
+- lib/betterdocs/dsl/json_type_mapper.rb
+- lib/betterdocs/dsl/naming.rb
+- lib/betterdocs/dsl/representer.rb
+- lib/betterdocs/dsl/result.rb
+- lib/betterdocs/dsl/result/collection_property.rb
+- lib/betterdocs/dsl/result/link.rb
+- lib/betterdocs/dsl/result/property.rb
+- lib/betterdocs/generator/config_shortcuts.rb
+- lib/betterdocs/generator/markdown.rb
+- lib/betterdocs/global.rb
+- lib/betterdocs/json_params_representer.rb
+- lib/betterdocs/json_params_representer_collector.rb
+- lib/betterdocs/mix_into_controller.rb
+- lib/betterdocs/rake_tasks.rb
+- lib/betterdocs/representer.rb
+- lib/betterdocs/result_representer.rb
+- lib/betterdocs/result_representer_collector.rb
+- lib/betterdocs/section.rb
+- lib/betterdocs/version.rb
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- COPYING
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- betterdocs.gemspec
+- lib/betterdocs.rb
+- lib/betterdocs/controller_collector.rb
+- lib/betterdocs/dsl.rb
+- lib/betterdocs/dsl/common.rb
+- lib/betterdocs/dsl/controller.rb
+- lib/betterdocs/dsl/controller/action.rb
+- lib/betterdocs/dsl/controller/action/param.rb
+- lib/betterdocs/dsl/controller/action/response.rb
+- lib/betterdocs/dsl/controller/controller.rb
+- lib/betterdocs/dsl/controller/controller_base.rb
+- lib/betterdocs/dsl/json_params.rb
+- lib/betterdocs/dsl/json_params/param.rb
+- lib/betterdocs/dsl/json_type_mapper.rb
+- lib/betterdocs/dsl/naming.rb
+- lib/betterdocs/dsl/representer.rb
+- lib/betterdocs/dsl/result.rb
+- lib/betterdocs/dsl/result/collection_property.rb
+- lib/betterdocs/dsl/result/link.rb
+- lib/betterdocs/dsl/result/property.rb
+- lib/betterdocs/generator/config_shortcuts.rb
+- lib/betterdocs/generator/markdown.rb
+- lib/betterdocs/generator/markdown/templates/README.md.erb
+- lib/betterdocs/generator/markdown/templates/section.md.erb
+- lib/betterdocs/global.rb
+- lib/betterdocs/json_params_representer.rb
+- lib/betterdocs/json_params_representer_collector.rb
+- lib/betterdocs/mix_into_controller.rb
+- lib/betterdocs/rake_tasks.rb
+- lib/betterdocs/representer.rb
+- lib/betterdocs/result_representer.rb
+- lib/betterdocs/result_representer_collector.rb
+- lib/betterdocs/section.rb
+- lib/betterdocs/tasks/doc.rake
+- lib/betterdocs/version.rb
+- spec/controller_dsl_spec.rb
+- spec/generator/markdown_spec.rb
+- spec/json_params_representer_spec.rb
+- spec/json_type_mapper_spec.rb
+- spec/result_representer_dsl_spec.rb
+- spec/result_representer_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/betterplace/betterdocs
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- 'Betterdocs -- '
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Betterplace API documentation library
+test_files:
+- spec/controller_dsl_spec.rb
+- spec/generator/markdown_spec.rb
+- spec/json_params_representer_spec.rb
+- spec/json_type_mapper_spec.rb
+- spec/result_representer_dsl_spec.rb
+- spec/result_representer_spec.rb
+- spec/spec_helper.rb