lit_doc 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01fa47592181c786d76c665e4df652cb9807129b
+  data.tar.gz: c3dd4dc2324965ef0b1b5df3cdbea32caf62cd0f
+SHA512:
+  metadata.gz: 9217466d62fe008d2a994c06d47b92ae920d3a673632a41893d213bd175d8d6b23854633b724f8e3fa625a0a5b5f39f7d228a933f35be7ffad45110e01fb138e
+  data.tar.gz: 66dc4dfa84abf7e8fd39ee71ab5520ef3f65161a44748aaa75f26d838559246f510b56f6474bbdd340357b022cfd9c01ca6c243d8f5849d9c8883f6e566216ee

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+spec/support/rails_app/doc/gen/generated.md

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at humoud.alsaleh@kgl.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lit_doc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Homood
+
+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,99 @@
+# Lit Doc 🔥
+[![Build Status](https://travis-ci.org/Humoud/lit_doc.svg?branch=master)](https://travis-ci.org/Humoud/lit_doc)
+
+**this gem hasn't been released yet**
+
+This gem is a collection of Rake Tasks that make writing docs easier by
+allowing you to write the docs inside ruby files.
+It also makes documentation much less of a repetitive process.
+That is done by using the Lit Doc code to generate the repetitive parts of the doc.
+
+## Installation
+
+this gem hasn't been released yet
+
+## Usage
+
+1. run `rails lit_doc:prepare` generate the following:
+  1. doc/source/source.md
+  2. doc/gen/generate.md
+2. in source.md import the files that contain lit doc documentation like so:
+  * `@import "app/controllers/application_controller.rb"`
+3. run `rails lit_doc:generate` to generate a doc. You can find the result in doc/gen/generate.md.
+
+## End Goal Usage Scenario
+in source.md:
+
+have a mixture of markdown syntax and "@import 'rails.root/path_to_file'" statements
+the markdown syntax will be copied as it is to the generate.md while the imported files
+will be scanned for Lit Doc code.
+
+Lit Doc code example:
+Let's say we have a controller that we want to document some actions/methods in it.
+above each action that the user wishes to document, he/she will use the following syntax:
+
+**NOTE:** Lit Doc syntax starts with 2 hashtags
+``` ruby
+## @h: header text
+## @r: http method route
+## @b-model: path to model
+## @b-serializer: path to serializer
+## @res-model: path to model
+## @res-serializer: path to serializer
+## regular markdown
+def index
+  ## do something
+end
+
+# Example:
+# in app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  ## @h: User Create
+  ## @r: POST /users
+  ## @b-model: User
+  ## @res-model: User
+  ## **NOTE:** This needs optimization
+  def create
+    ## do something
+  end
+end
+
+# and in app/models/user.rb
+class User < ApplicationRecord
+  ## @b:
+  ##  {
+  ##    name: 'tim',
+  ##    email: "tim@mailz.com"
+  ##  }
+
+  ## @res:
+  ## {
+  ##   name: 'tim',
+  ##   email: "tim@mailz.com",
+  ##   updated_at: "91231-543-157",
+  ##   created_at: "123-1231-123"
+  ## }
+end
+```
+
+A brief example of the Lit Doc code/syntax:
+
+* `@h` means header.
+* `@r` means route.
+* `@b` means body and `@res` means response.
+* `@b-model` means generating body using model  and `@res-model` means generating
+* response using model.
+
+## Development
+
+run tests with `rake spec`
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Humoud/lit_doc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "lit_doc"
+
+# 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/lit_doc/railtie.rb

@@ -0,0 +1,5 @@
+class LitDoc::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/lit_doc.rake'
+  end
+end

data/lib/lit_doc/version.rb

@@ -0,0 +1,3 @@
+module LitDoc
+  VERSION = "0.1.0.pre"
+end

data/lib/lit_doc.rb

@@ -0,0 +1,6 @@
+require "lit_doc/version"
+require "lit_doc/railtie" if defined?(Rails)
+
+module LitDoc
+  # Your code goes here...
+end

data/lib/modules/scanner.rb

@@ -0,0 +1,163 @@
+module Scanner
+
+  # return all files to be imported/scanned(files that contain lit doc)
+  def read_source_file(file_path)
+    import_file_paths = []
+
+    File.open(file_path, "r").each_line do |line|
+      line.lstrip!
+      args = line.split(' ')
+      # puts "arguments in source.md: #{args}"
+      if args[0] == "@import"
+        import_file_paths.push(args[1].gsub('"', ''))
+      end
+    end
+
+    return import_file_paths
+  end
+
+  # go through imported files and return lines that contain lit doc code
+  def scan_file(file_paths, root_path=Rails.root)
+    lines_with_doc = []
+
+    file_paths.each do |path|
+      File.open("#{root_path}/#{path}", "r").each_line do |line|
+        # regex: lines that satisfy the following conditions:
+        # 1. can start with a white space
+        # 2. start with 2 hashtags
+        if (line[/^\s*##.*/])
+          # remove trailing and leading white space and add to array
+          lines_with_doc.push(line.strip)
+        end
+      end
+    end
+
+    return lines_with_doc
+  end
+  ##############################################################################
+  ### detect lit doc code and process it
+  ### lit code syntax:
+  ## @h: header text
+  ## @r: http method route
+  ## @b-model: path to model
+  ## @b-serializer: path to serializer
+  ## @res-model: path to model
+  ## @res-serializer: path to serializer
+  ## regular markdown
+  def process_lines(lines, generated_file_path)
+    lines.each do |line|
+      args = line.split(' ')
+      case args[1]
+      when "@h:"
+        # puts "this is a header"
+        # remove first 2 entries in array
+        args.shift(2)
+        process_header(args, generated_file_path)
+      when "@b-model:"
+        # puts "this is a body"
+        # remove first 2 entries in array
+        args.shift(2)
+        process_body_model(args, generated_file_path)
+      when "@res-model:"
+        # puts "this is a response"
+        # remove first 2 entries in array
+        args.shift(2)
+        process_response_model(args, generated_file_path)
+      else
+        # puts "this is regular markdown"
+        # remove first entry in array
+        args.shift
+        process_markdown(args, generated_file_path)
+      end
+    end
+  end
+
+  private
+    ############################################################################
+    #### FORMAT:
+    # TODO user passes size of headers(number of # to print) when importing
+    #
+    def process_header(args, file_path)
+      # puts "args: #{args}"
+      args = args.join(' ')
+      File.open(file_path, "a") do |f|
+        f << "#### #{args}"
+        f << "\n"
+      end
+    end
+
+    def process_body_model(args, file_path)
+      # puts "args: #{args}"
+      args = args.join(' ').strip
+      lines = scan_model_for_body(args)
+      File.open(file_path, "a") do |f|
+        lines.each do |l|
+          f << l
+          f << "\n"
+        end
+      end
+    end
+
+    def process_response_model(args, file_path)
+      # puts "args: #{args}"
+      args = args.join(' ').strip
+      lines = scan_model_for_response(args)
+      File.open(file_path, "a") do |f|
+        lines.each do |l|
+          f << l
+          f << "\n"
+        end
+      end
+    end
+
+    def process_markdown(args, file_path)
+      # puts "args: #{args}"
+      args = args.join(' ')
+      File.open(file_path, "a") do |f|
+        f << "#{args}"
+        f << "\n"
+      end
+    end
+
+    ############################################################################
+    ####### GET RESPONSE AND BODY FROM MODEL
+    ### detect lit doc code and process it
+    ### lit code syntax:
+    ## @h: header text
+    ## @b: body
+    ## @res: response
+    def scan_model_for_body(model_name)
+      return scan_model("@b:", model_name)
+    end
+
+    def scan_model_for_response(model_name)
+     return scan_model("@res:", model_name)
+    end
+
+    def scan_model(switch, model_name)
+      path = "app/models/#{model_name.downcase}.rb"
+      scanned_docs = []
+      read_doc_flag = false
+      File.open(path, "r").each_line do |line|
+        if (line[/^\s*##.*/])
+          args = line.strip.split(' ')
+          # at start of body doc
+          if args[1] == switch
+            read_doc_flag = true
+            scanned_docs.push("``` json")
+          elsif read_doc_flag
+            args.shift(1)
+            doc = args.join(' ')
+            scanned_docs.push("#{doc}")
+          end
+        else
+          # line has no ##, switch read flag off
+          if read_doc_flag
+            read_doc_flag = false
+            scanned_docs.push("```")
+          end
+        end
+      end
+      return scanned_docs
+    end
+end

data/lib/tasks/lit_doc.rake

@@ -0,0 +1,36 @@
+# should be at root of rails app for this to work
+require 'modules/scanner'
+include Scanner
+
+namespace :lit_doc do
+  @generated_file_path = "doc/gen/generated.md"
+  ##########################################################################
+  ###       CREATE FILES AND FOLDERS DEPENDENCIES
+  #
+  directory "doc"
+  directory "doc/gen" => "doc"
+  directory "doc/source" => "doc"
+  file "doc/source/source.md" => ["doc/source", "doc/gen"] do
+    touch "doc/source/source.md"
+  end
+  file @generated_file_path => "doc/source/source.md" do
+    touch @generated_file_path
+  end
+
+  task :prepare => ["doc/source/source.md", @generated_file_path]
+
+  ##########################################################################
+  ###  Lit Doc Rake Task
+  #
+  task :generate => :prepare do
+    puts "Reading list of files to scan:"
+    # get files that are imported
+    file_paths = Scanner.read_source_file("doc/source/source.md")
+    puts "files to be imported: #{file_paths}"
+    # get lines that contain lit doc code
+    lines_with_docs = Scanner.scan_file(file_paths)
+    # puts "lines that contain doc syntax: #{lines_with_docs}"
+    # process lines
+    process_lines(lines_with_docs, @generated_file_path)
+  end
+end

data/lit_doc.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lit_doc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lit_doc"
+  spec.version       = LitDoc::VERSION
+  spec.authors       = ["Humoud"]
+  spec.email         = ["humoud.m.alsaleh@gmail.com"]
+
+  spec.summary       = "Makes documenting Rails APIs swift and easy."
+  spec.description   = "Used to generate markdown docs for Rails API projects"
+  spec.homepage      = "https://github.com/Humoud/lit_doc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activesupport", "~> 5.1"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: lit_doc
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Humoud
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Used to generate markdown docs for Rails API projects
+email:
+- humoud.m.alsaleh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lit_doc.rb
+- lib/lit_doc/railtie.rb
+- lib/lit_doc/version.rb
+- lib/modules/scanner.rb
+- lib/tasks/lit_doc.rake
+- lit_doc.gemspec
+homepage: https://github.com/Humoud/lit_doc
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Makes documenting Rails APIs swift and easy.
+test_files: []