user_docs 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64df02f91cb36adad712ca2f19b58e4d71eea217de85d85d4bfe4fa57b3ac1dd
-  data.tar.gz: 4baa6edafb2e67d7712468ec529dc919659b707a196e01e8508a64431f0a9da7
+  metadata.gz: 17570ca7f142aca7a866a337055a720d2acae9ea4c851f0b9a6b8ca3274c5be9
+  data.tar.gz: 7b7226c0791a3256f6c718d5388d001c9cab842e9798fe5b32ef02b4e32f532e
 SHA512:
-  metadata.gz: d7cfe269de8a69090bbfdd3837c6dc6053a8a954358e1860e6f591d542e860a058110989fb43abd6eb8817463952b9f57a9f0dd9773972a813f271de2cd1443d
-  data.tar.gz: 5058a48858055378b230d543a9ada63fe0b907d117ca56d9111e04499f0b81604e5bc5be58c41322e80ac0b8118d5036d4527e06ec6ffe876a982647624b3708
+  metadata.gz: bff557e8d7dc2f577bbd9789c1f4bd928f45b776cb7b4f824303d2513e20a4498ec439f90eee27c29d0589f30f586b3b224226f76a4251a37a60ef534a5c2b2f
+  data.tar.gz: 94710b2d8796ab802bf14068787ea5dccc007477289b0b42a0a13e7a30be1394c153e403bd2fbeb2b35df99ed3d9bc07282384844b3f861a8d231dc0fc301f83

data/lib/generators/user_docs/install_generator.rb

@@ -10,6 +10,7 @@ module UserDocs
     def create
       check_for_version
 
+      template "_config", ".docs/_config.yml"
       template "index", ".docs/index.html"
       template "_layouts/default", ".docs/_layouts/default.html"
       template "_includes/index", ".docs/_includes/index.html"

data/lib/generators/user_docs/templates/_config.tt

@@ -0,0 +1 @@
+keep_files: ['versions', 'assets']

data/lib/tasks/user_docs_tasks.rake

@@ -13,6 +13,6 @@ namespace :user_docs do
       jekyll build
       --source #{temp_dir} --destination #{output_dir} --baseurl /docs
     CMD
-    FileUtils.rm_rf(Rails.root.join(".docs"))
+    FileUtils.rm_rf(temp_dir)
   end
 end

data/lib/user_docs/capybara_extension.rb

@@ -11,23 +11,19 @@ module UserDocs
 
     check_installation
 
-    @class_name = class_name.chomp("Test")
+    @class_name = class_name.chomp("Procedure")
     @method = name.sub("test_", "")
     make_version_data_directory
     make_version_index
     Capybara.save_path =
-      Rails.root.join(".docs", "assets", @class_name, @method)
+      Rails.root.join(".docs/assets/#{version}/#{klass_name}/#{@method}")
 
     @json = { name: @method.humanize, steps: [] }
   end
 
   def before_teardown
-    File.write(
-      Rails.root.join(
-        ".docs", "_data", "versions", version_data_directory_name,
-        @class_name, "#{@method}.json"
-      ), @json.to_json
-    )
+    path = ".docs/_data/versions/#{version}/#{klass_name}/#{@method}.json"
+    File.write(Rails.root.join(path), @json.to_json)
 
     super
   end
@@ -46,22 +42,22 @@ module UserDocs
     Rails.application.class.module_parent::VERSION
   end
 
-  def version_data_directory_name
-    version.tr(".", "_")
+  def klass_name
+    @class_name.underscore
   end
 
   def make_version_data_directory
-    FileUtils.mkdir_p(
-      Rails.root.join(".docs", "_data", "versions",
-                      version_data_directory_name, @class_name)
-    )
+    data_path = Rails.root.join(".docs/_data/versions/#{version}/#{klass_name}")
+    FileUtils.mkdir_p(data_path)
   end
 
   # rubocop:disable Metrics/MethodLength
   def make_version_index
-    directory = "#{Rails.root}/.docs/versions/#{version}"
-    FileUtils.mkdir_p directory
-    output_file = "#{directory}/index.html"
+    directory = Rails.root.join(".docs/versions/#{version}")
+    output_file = directory + "index.html"
+    entry_file = Rails.root.join(".docs/index.html")
+
+    FileUtils.mkdir_p(directory)
     File.write(
       output_file,
       <<~HTML
@@ -73,7 +69,6 @@ module UserDocs
       HTML
     )
 
-    entry_file = Rails.root.join(".docs/index.html")
     FileUtils.cp_r(output_file, entry_file, remove_destination: true)
   end
   # rubocop:enable Metrics/MethodLength
@@ -102,7 +97,7 @@ module UserDocs
     image += ".png"
     super
 
-    path = "/docs/assets/#{@class_name}/#{@method}/#{image}"
+    path = "/docs/assets/#{version}/#{klass_name}/#{@method}/#{image}"
     @json[:steps] << "<img src='#{path}' class='img-fluid'>"
   end
 

data/lib/user_docs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UserDocs
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: user_docs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - jtopgi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -175,6 +175,7 @@ files:
 - README.md
 - Rakefile
 - lib/generators/user_docs/install_generator.rb
+- lib/generators/user_docs/templates/_config.tt
 - lib/generators/user_docs/templates/_includes/index.tt
 - lib/generators/user_docs/templates/_layouts/default.tt
 - lib/generators/user_docs/templates/index.tt