rtfdoc 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6fe3681c1ed97593bf930b2affe79ce710f8e02ba25220fc2568eb259819907
-  data.tar.gz: 1987316da892c9fafc03b7d541cd772cb767c51730729a2063108048d8bec032
+  metadata.gz: 9526652b8cb796b8c425a270dbe24db31c72ac74dbc7b747dc467de1b45a9134
+  data.tar.gz: 8a155561cd6a0a949a872618f09ef694405e4d013fa1a6089467cc5d3f933d9f
 SHA512:
-  metadata.gz: c0993193c6965352819b9e435b3333b5890a98bc685cfc293bc613e97ffc8e72489b4898471ad2e9537d0ab6334e191c30e864deaa17f5a1917baaf3b41d830d
-  data.tar.gz: 449972e46595c02fdda34c6957e7a37ec7e6222ca88dbbbd96e3d3d246438e33d39da704b8df9dbddbbc231964bbce32aa9957fcc823ba28643e265522730448
+  metadata.gz: c67015811940e7cda515507725424bb9c7f9fc3b4c618cc86de0232d26762c29a522cdff08cf158f924fd4c7bd2a2693c64246184120b9b6eca5b670323df73f
+  data.tar.gz: 3eea133c9c2f2672ae869c0afa73bdaa6c871cc012bbb9576f4e554d35080c1069163abad49c572c568607bb8bafa2d0b7e5c51711dc70219b34a1bdf8cf0b46

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    rtfdoc (0.1.2)
+    rtfdoc (0.1.3)
       erubi (~> 1.9.0)
       redcarpet (~> 3.5.0)
-      rouge (~> 3.20.0)
+      rouge (~> 3.22.0)
       thor (~> 1.0.1)
 
 GEM
@@ -17,11 +17,11 @@ GEM
     irb (1.2.4)
       reline (>= 0.0.1)
     minitest (5.14.1)
-    rake (10.5.0)
+    rake (13.0.1)
     redcarpet (3.5.0)
     reline (0.1.4)
       io-console (~> 0.5)
-    rouge (3.20.0)
+    rouge (3.22.0)
     thor (1.0.1)
 
 PLATFORMS
@@ -33,7 +33,7 @@ DEPENDENCIES
   byebug
   irb
   minitest (~> 5.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rtfdoc!
 
 BUNDLED WITH

data/README.md

@@ -14,7 +14,8 @@ $ gem install rtfdoc
 
 You can scaffold a new project using `rtfdoc bootstrap <project_name>`. It will create a skeleton for your project, and generate needed configuration files.
 
-Once in your project directory, you can install ruby dependencies using `bundle install` and javascript dependencies using `yarn install`.
+Once in your project directory, you can install ruby dependencies using `bundle install` and javascript dependencies using `yarn install`. Then we want to stub the binary by running `bundle binstubs bundler rtfdoc`.
+And finally, you'll copy the assets source by running `bin/rtfdoc install`.
 
 By convention, you should put your documentation content under the `content/` directory. If you don't follow this convention, don't forget to modify the configuration file as well.
 

data/lib/rtfdoc.rb

@@ -111,9 +111,13 @@ module RTFDoc
   end
 
   class Template
-    def initialize(sections)
-      @content = sections.map(&:output).join
+    attr_reader :app_name, :page_title
+
+    def initialize(sections, config)
+      @content      = sections.map(&:output).join
       @menu_content = sections.map(&:menu_output).join
+      @app_name     = config['app_name']
+      @page_title   = config['title']
     end
 
     def output
@@ -335,7 +339,7 @@ module RTFDoc
       end
 
       out = File.new("#{Dir.tmpdir}/rtfdoc_output.html", 'w')
-      out.write(Template.new(nodes).output)
+      out.write(Template.new(nodes, config).output)
       out.close
     end
 

data/lib/rtfdoc/cli.rb

@@ -3,6 +3,8 @@ require 'rtfdoc/generators/bootstrap'
 
 module RTFDoc
   class CLI < Thor
+    include Thor::Actions
+
     def self.exit_on_failure?
       true
     end
@@ -14,5 +16,12 @@ module RTFDoc
     def convert
       ::RTFDoc::Generator.new(options[:config]).run
     end
+
+    source_root(File.expand_path('../../', __dir__))
+
+    desc 'install', 'Copy the latest version of the assets source in your project'
+    def install
+      directory 'src', 'src', exclude_pattern: /\.erb\Z/
+    end
   end
 end

data/lib/rtfdoc/generators/bootstrap.rb

@@ -25,18 +25,11 @@ module RTFDoc
 
     def create_webpack_config
       template('package.json.erb', "#{name}/package.json")
-      template('webpack.config.js.erb', "#{name}/webpack.config.js")
+      copy_file('webpack.config.js', "#{name}/webpack.config.js")
     end
 
     def create_config
       template('config.yml.erb', "#{name}/config.yml")
     end
-
-    private
-
-    def gem_dir
-      File.expand_path('../../../', __dir__)
-    end
-
   end
 end

data/lib/rtfdoc/templates/{webpack.config.js.erb → webpack.config.js}

@@ -8,13 +8,13 @@ const devMode = process.env.NODE_ENV != 'production'
 
 module.exports = {
   mode: devMode ? "development" : "production",
-  entry: "<%= gem_dir %>/src/js/index.js",
+  entry: __dirname + "/src/js/index.js",
   output: {
     filename: devMode ? "main.js" : "main.[contenthash].js",
     path: __dirname + "/dist",
   },
   plugins: [
-    new CleanWebpackPlugin(),
+    new CleanWebpackPlugin({ cleanStaleWebpackAssets: !devMode }),
     new MiniCssExtractPlugin({
       filename: devMode ? '[name].css' : '[name].[contenthash].css'
     }),
@@ -23,6 +23,9 @@ module.exports = {
     })
   ],
   devtool: devMode ? "inline-source-map" : "source-map",
+  resolve: {
+    modules: [path.resolve(__dirname, 'node_modules')]
+  },
   module: {
     rules: [
       {

data/lib/rtfdoc/version.rb

@@ -1,3 +1,3 @@
 module RTFDoc
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/rtfdoc.gemspec

@@ -37,11 +37,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "erubi", "~> 1.9.0"
-  spec.add_dependency "rouge", "~> 3.20.0"
+  spec.add_dependency "rouge", "~> 3.22.0"
   spec.add_dependency "redcarpet", "~> 3.5.0"
   spec.add_dependency "thor", "~> 1.0.1"
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

data/src/attributes.erb

@@ -30,11 +30,11 @@
             <% hash['children'].each do |child_name, child_hash| %>
               <li class="list-item">
                 <div class="list-item-label">
-                  <div class="list-item-name"><%= name %></div>
-                  <div class="list-item-type"><%= hash['type'] %> </div>
+                  <div class="list-item-name"><%= child_name %></div>
+                  <div class="list-item-type"><%= child_hash['type'] %> </div>
                 </div>
                 <div class="list-item-description">
-                  <p><%= hash['desc'] %></p>
+                  <p><%= child_hash['desc'] %></p>
                 </div>
               </li>
             <% end %>

data/src/css/application.scss

@@ -544,7 +544,7 @@ p code {
   border: 1px solid var(--inline-code-border);
   padding: 2px 3px 0;
   margin: 0 1px;
-  font-size: 15px;
+  font-size: var(--code-font-size);
   font-family: var(--monospace-font);
   font-weight: 500;
   background: var(--inline-code-background); }

data/src/index.html.erb

@@ -3,7 +3,7 @@
 
 <head>
   <meta charset="utf-8">
-  <title>RTFDoc</title>
+  <title><%= page_title %></title>
   <meta name="description" content="">
   <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
@@ -11,7 +11,7 @@
   <div id="sidebar" class="sidebar">
     <div class="sidebar-header">
       <div class="sidebar-title">
-        odyssey <span class="api">api</span>
+        <%= app_name %> <span class="api">api</span>
       </div>
       <div class="theme-switch-wrapper">
         <div class="theme-switch">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtfdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - ccocchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubi
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.20.0
+        version: 3.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.20.0
+        version: 3.22.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -132,7 +132,7 @@ files:
 - lib/rtfdoc/templates/config.yml.erb
 - lib/rtfdoc/templates/gitignore
 - lib/rtfdoc/templates/package.json.erb
-- lib/rtfdoc/templates/webpack.config.js.erb
+- lib/rtfdoc/templates/webpack.config.js
 - lib/rtfdoc/version.rb
 - rtfdoc.gemspec
 - src/attributes.erb