lx_docs 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d1894d79732ca28d38fe2447923d6273bdbf0a7c38b72629fae2c996036e2d0
+  data.tar.gz: 74bdca2fba40b9b34bd6445b6d9972ae3c4efad194003157728eb1e9902d9d55
+SHA512:
+  metadata.gz: 49fd12044815f6c13a2134598ec93c76c2a75d7f5af466fbb3865296d55966ca05792748b4c9c2f403646e6f9fd0d3d91e1f5d282db31f5a9c1f2f9d1d17a3a2
+  data.tar.gz: 2b1159ad7c4cdd06da8bbab74b8d93897461eb81599dc5ae5b3e414de9afbd0e41da9c04fe653ebebf0edbd19b2303a7f64bade13e4b9507fa29cef68ea3254f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lx_docs.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    lx_docs (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  lx_docs!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alex Clink
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# LxDocs
+
+Generate automatic documentation for rails
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lx_docs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lx_docs
+
+## Usage
+
+`rake lx_docs:generate`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sleepinginsomniac/lx_docs.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lx_docs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lx_docs/railtie.rb

@@ -0,0 +1,55 @@
+module LxDocs
+  class Railtie < Rails::Railtie
+
+    rake_tasks do
+      namespace :lx_docs do
+        desc "Generate"
+        task :generate => :environment do
+      
+          versions = {}
+
+          routes = Rails.application.routes.routes.map do |route|
+            next unless route.defaults[:controller]
+            controller_path = route.defaults[:controller] + '_controller'
+            controller_class = controller_path.classify.constantize
+            controller_file_path = Rails.root.join('app', 'controllers', controller_path + '.rb').to_s
+
+            next unless File.exists?(controller_file_path)
+
+            defined_in = controller_class.to_s.split('::').tap{ |a| a.pop }.join('/').downcase
+            defined_in = 'root' if defined_in.blank?
+
+            versions[defined_in] ||= { controllers: {} }
+            controllers = versions[defined_in][:controllers]
+
+            action_name = route.defaults[:action].to_sym
+            action_method = controller_class.instance_method(action_name)
+
+            controllers[controller_path] ||= {
+              controller: controller_path.classify,
+              source_location: {
+                file: controller_file_path[Rails.root.to_s.length..-1]
+              }
+            }
+
+            controllers[controller_path][:actions] ||= {}
+            controllers[controller_path][:actions][action_name] ||= { paths: [], verbs: [], formats: [] }
+            controllers[controller_path][:actions][action_name][:paths].push(route.path.spec.to_s).uniq!
+            controllers[controller_path][:actions][action_name][:verbs].push(route.verb).uniq!
+            controllers[controller_path][:actions][action_name][:formats].push(route.defaults[:format]).uniq!
+
+            action_file, action_file_line = action_method.source_location
+
+            controllers[controller_path][:actions][action_name][:source_location] ||= {
+              file: action_file[Rails.root.to_s.length..-1],
+              line: action_file_line
+            }
+          end
+
+          puts JSON.pretty_generate(versions)
+        end
+      end
+    end 
+    
+  end
+end

data/lib/lx_docs/use_case.rb

@@ -0,0 +1,82 @@
+require 'json'
+
+module LxDocs
+  class UseCase
+    def self.defined
+      @use_cases ||= {}
+    end
+
+    def self.add(title, version, *args, &block)
+      self.defined[version] ||= {}
+      self.defined[version][title] = new(title, version, *args).tap do |use_case|
+        use_case.instance_eval(&block)
+      end
+    end
+
+    attr_reader :info
+
+    def initialize(title, version, controller = nil, action = nil)
+      @version = version
+      @controller = controller
+      @action = action
+      @info = {
+        title: title,
+        description: '',
+        parameters: {},
+        responses: [],
+        examples: [],
+        includes: []
+      }
+    end
+
+    def description(value)
+      @info[:description] = value
+    end
+
+    def parameter(name, **opts)
+      @info[:parameters][name.to_sym] = opts
+    end
+
+    def example(value)
+      @info[:examples] << value
+    end
+
+    def response(code, body = nil, description = nil)
+      @info[:responses] << {
+        code: code,
+        body: body,
+        description: description
+      }
+    end
+
+    def includes(other)
+      @info[:includes] << other
+      other = LxDocs::UseCase.defined[@version][other]
+      @info[:parameters].merge!(other.info[:parameters])
+      @info[:responses] |= other.info[:responses]
+      @info[:examples] |= other.info[:examples]
+    end
+
+    def to_json(*args)
+      @info.to_json(*args)
+    end
+  end
+end
+
+# LxDocs::UseCase.add('pagination', 'Api::V1') do
+#   parameter :page, type: 'integer', default: 1
+#   parameter :limit, type: 'integer', default: 10
+# end
+#
+# LxDocs::UseCase.add('listing shoes', 'Api::V1', 'Shoes', :index) do
+#   description "Get an index of shoes"
+#
+#   example "api/v1/shoes?page=1&limit=10"
+#
+#   response 200
+#   response 403, { error: 'Forbidden' }.to_json, "When the user is not logged in"
+#
+#   includes 'pagination'
+# end
+#
+# puts JSON.pretty_generate(LxDocs::UseCase.defined)

data/lib/lx_docs/version.rb

@@ -0,0 +1,3 @@
+module LxDocs
+  VERSION = "0.1.1"
+end

data/lib/lx_docs.rb

@@ -0,0 +1,5 @@
+require "lx_docs/version"
+require 'lx_docs/railtie' if defined?(Rails)
+
+module LxDocs
+end

data/lx_docs.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lx_docs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lx_docs"
+  spec.version       = LxDocs::VERSION
+  spec.authors       = ["Alex Clink"]
+  spec.email         = ["code@alexclink.com"]
+
+  spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}
+  spec.summary       = "Generate docs for your rails api"
+  spec.description   = "Automatically gathers your routes into a machine readable json file and provides a DSL for docs"
+  spec.homepage      = "https://pixelfaucet.com/software/rails_api_docs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: lx_docs
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alex Clink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Automatically gathers your routes into a machine readable json file and
+  provides a DSL for docs
+email:
+- code@alexclink.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lx_docs.rb
+- lib/lx_docs/railtie.rb
+- lib/lx_docs/use_case.rb
+- lib/lx_docs/version.rb
+- lx_docs.gemspec
+homepage: https://pixelfaucet.com/software/rails_api_docs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Generate docs for your rails api
+test_files: []