lit_doc 0.1.0.pre → 0.1.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01fa47592181c786d76c665e4df652cb9807129b
-  data.tar.gz: c3dd4dc2324965ef0b1b5df3cdbea32caf62cd0f
+  metadata.gz: 5b2bf42a0be7604c9ea09d497743ffc04a04fc47
+  data.tar.gz: 809ea9a2ec38b4b5eddf3ff08ce922b259124f3a
 SHA512:
-  metadata.gz: 9217466d62fe008d2a994c06d47b92ae920d3a673632a41893d213bd175d8d6b23854633b724f8e3fa625a0a5b5f39f7d228a933f35be7ffad45110e01fb138e
-  data.tar.gz: 66dc4dfa84abf7e8fd39ee71ab5520ef3f65161a44748aaa75f26d838559246f510b56f6474bbdd340357b022cfd9c01ca6c243d8f5849d9c8883f6e566216ee
+  metadata.gz: 1cd80387090c1641d05c04722ae6e6015bc8b2bf07c58b78a4f500d6410ac06be381ea2fb423acdd532604037c3d1498e37eeff5507273762b16022c8c3bf7ec
+  data.tar.gz: df3cb53f9d03be289ebb85fd01df17a91efef27a32d8d7ec159e3a99b58017ed43df402cf2e86409e5504dda80c60246ba89689bb5428f16cf9e3861956a31e9

data/README.md

@@ -1,8 +1,6 @@
 # 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.
@@ -10,7 +8,11 @@ That is done by using the Lit Doc code to generate the repetitive parts of the d
 
 ## Installation
 
-this gem hasn't been released yet
+`gem install lit_doc --pre`
+
+or in rails gemfile
+
+`gem "lit_doc", "0.1.1.pre"`
 
 ## Usage
 
@@ -46,6 +48,10 @@ def index
 end
 
 # Example:
+# in doc/source/source.md:
+# where h: 2 is the number of #'s before the @h header
+@import "app/controllers/users_controller.rb", {h: 2}
+
 # in app/controllers/users_controller.rb
 class UsersController < ApplicationController
   ## @h: User Create

data/lib/lit_doc/version.rb

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

data/lib/modules/scanner.rb

@@ -1,27 +1,54 @@
 module Scanner
 
   # return all files to be imported/scanned(files that contain lit doc)
+  # and headers sizes for each file
+  # returns array of hashes:
+  # [ { file: "file_path", header_sizes: {h: integer} } ]
   def read_source_file(file_path)
-    import_file_paths = []
+    file_paths_and_header_sizes = []
 
     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('"', ''))
+        # see if {h: 1} pattern exists
+        header_sizes = line[/{\s*h:\s*[0-9]\s*}/]
+        header_hash = Hash.new
+        # if user passed sizes
+        if header_sizes
+          # convert str to ruby hash
+          header_hash = eval header_sizes
+        # set default size
+        else
+          header_hash = {h: 2}
+        end
+        file_path = args[1][/".*"/]
+
+        hash = {file: file_path.gsub('"', ''), header_sizes: header_hash}
+        file_paths_and_header_sizes.push(hash)
       end
     end
 
-    return import_file_paths
+    return file_paths_and_header_sizes
   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 = []
+  # returns an array of hashes with the following format:
+  # {
+  #   file:
+  #   {
+  #       sizes: {h: integer},
+  #       lines: ["line of lit doc code"]
+  #   }
+  # }
+  def scan_file(file_paths_and_sizes, root_path=Rails.root)
+    lines_and_header_sizes = []
 
-    file_paths.each do |path|
-      File.open("#{root_path}/#{path}", "r").each_line do |line|
+    file_paths_and_sizes.each do |path_and_size|
+      lines_with_doc = []
+      
+      File.open("#{root_path}/#{path_and_size[:file]}", "r").each_line do |line|
         # regex: lines that satisfy the following conditions:
         # 1. can start with a white space
         # 2. start with 2 hashtags
@@ -30,9 +57,19 @@ module Scanner
           lines_with_doc.push(line.strip)
         end
       end
+
+      lines_and_header_sizes.push(
+        {
+          file:
+          {
+              sizes: path_and_size[:header_sizes],
+              lines: lines_with_doc
+          }
+        }
+      )
     end
 
-    return lines_with_doc
+    return lines_and_header_sizes
   end
   ##############################################################################
   ### detect lit doc code and process it
@@ -44,30 +81,33 @@ module Scanner
   ## @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)
+  def process_lines(files_and_header_sizes, generated_file_path)
+    files_and_header_sizes.each do |entry|
+      entry[:file][: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)
+          header_size = entry[:file][:sizes][:h]
+          process_header(args, generated_file_path, header_size)
+        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
   end
@@ -77,11 +117,14 @@ module Scanner
     #### FORMAT:
     # TODO user passes size of headers(number of # to print) when importing
     #
-    def process_header(args, file_path)
+    def process_header(args, file_path, header_size)
       # puts "args: #{args}"
       args = args.join(' ')
       File.open(file_path, "a") do |f|
-        f << "#### #{args}"
+        str = " #{args}"
+        header_size.to_i.times{ str.insert(0, "#")}
+        # write to file
+        f << str
         f << "\n"
       end
     end

data/lib/tasks/lit_doc.rake

@@ -25,12 +25,12 @@ namespace :lit_doc do
   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")
+    file_paths_and_header_sizes = 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)
+    lines_and_header_sizes = Scanner.scan_file(file_paths_and_header_sizes)
     # puts "lines that contain doc syntax: #{lines_with_docs}"
     # process lines
-    process_lines(lines_with_docs, @generated_file_path)
+    process_lines(lines_and_header_sizes, @generated_file_path)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lit_doc
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.1.pre
 platform: ruby
 authors:
 - Humoud
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-20 00:00:00.000000000 Z
+date: 2017-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler