nexmo_markdown_renderer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf72d97b82f7c671efe8a44e8699732332a3e59c3cbb7df3b6f87ec37a790a5d
-  data.tar.gz: 91763b45e66bf134adb6c4297b0967625a355ff0054686bfb6b70fb680f0e7f8
+  metadata.gz: 0a7ee181316166581904d3090d0921bdd910fd04f3b82c3f0c79466c18c9161b
+  data.tar.gz: 47df143beda5e33479d632ad8de13e6b9af55103fe581d1d368ec75101c6bacf
 SHA512:
-  metadata.gz: 5b60124cae98030eea13ec9498733c234dee46cf704238ee3252d70743a2a96e705983100c66c97a6d0ddad7fa4f3046b37aea5912805c32bd8396016efe8698
-  data.tar.gz: '0458dfbbaf465ea60949c8e359d7db9bc3df2acbd9a2c5eba484015ce179c6225e4e647810508c38fbf578674eb31c630f92512437f05e66fd22e7d9410ff0d3'
+  metadata.gz: 9d394cb2a18d09357457307975ce286ec1d933cb38012ff735c342f211d1b381dda8707b5e012a5eee45c28caf57085bf52ab8d485005fff631a2dfc9044bc87
+  data.tar.gz: ecdeb294a4f147299e62863dc0120acc626e07d93eaa2433a2df67db42ba4dca81a4d09c782a353ee992aef26aa6be43409d5cfc7f37dca7f82e55166fca27c3

data/lib/nexmo_markdown_renderer.rb

@@ -6,6 +6,7 @@ require 'nokogiri'
 require 'open-uri'
 require 'active_model'
 require 'i18n'
+require_relative 'nexmo_markdown_renderer/config/load_config'
 require_relative 'nexmo_markdown_renderer/initializers/redcarpet'
 require_relative 'nexmo_markdown_renderer/initializers/i18n'
 require_relative 'nexmo_markdown_renderer/core_ext/string'

data/lib/nexmo_markdown_renderer/config/load_config.rb

@@ -0,0 +1,9 @@
+module Nexmo
+  module Markdown
+    class Config
+      def self.docs_base_path
+        @docs_base_path ||= (defined?(Rails) && Rails.application != nil && Rails.application.configuration.docs_base_path) || ENV.fetch('DOCS_BASE_PATH', '.')
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/filters/code_filter.rb

@@ -6,12 +6,12 @@ module Nexmo
           config = YAML.safe_load($1)
     
           if config['config']
-            configs = YAML.load_file("#{ENV['DOCS_BASE_PATH']}/config/code_examples.yml")
+            configs = YAML.load_file("#{Nexmo::Markdown::Config.docs_base_path}/config/code_examples.yml")
             config = config['config'].split('.').inject(configs) { |h, k| h[k] }
           end
     
-          code = File.read("#{ENV['DOCS_BASE_PATH']}/#{config['source']}")
-          language = File.extname("#{ENV['DOCS_BASE_PATH']}/#{config['source']}")[1..-1]
+          code = File.read("#{Nexmo::Markdown::Config.docs_base_path}/#{config['source']}")
+          language = File.extname("#{Nexmo::Markdown::Config.docs_base_path}/#{config['source']}")[1..-1]
           lexer = language_to_lexer(language)
     
           total_lines = code.lines.count
@@ -59,4 +59,4 @@ module Nexmo
     end
     
   end
-end
+end

data/lib/nexmo_markdown_renderer/filters/code_snippet_filter.rb

@@ -66,7 +66,7 @@ module Nexmo
       end
     
       def generate_code_block(language, input, unindent)
-        filename = "#{ENV['DOCS_BASE_PATH']}/#{input['source']}"
+        filename = "#{Nexmo::Markdown::Config.docs_base_path}/#{input['source']}"
         return '' unless input
         raise "CodeSnippetFilter - Could not load #{filename} for language #{language}" unless File.exist?(filename)
     

data/lib/nexmo_markdown_renderer/filters/code_snippets_filter.rb

@@ -89,7 +89,7 @@ module Nexmo
       end
     
       def content_from_source
-        source_path = "#{ENV['DOCS_BASE_PATH']}/#{@config['source']}/*.yml"
+        source_path = "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}/*.yml"
     
         files = Dir[source_path]
         raise "No .yml files found for #{@config['source']} code snippets" if files.empty?

data/lib/nexmo_markdown_renderer/filters/modal_filter.rb

@@ -11,7 +11,7 @@ module Nexmo
         end
     
         modals = modals.map do |modal|
-          filename = "#{ENV['DOCS_BASE_PATH']}/#{modal[:document]}"
+          filename = "#{Nexmo::Markdown::Config.docs_base_path}/#{modal[:document]}"
           raise "Could not find modal #{filename}" unless File.exist? filename
     
           document = File.read(filename)

data/lib/nexmo_markdown_renderer/filters/partial_filter.rb

@@ -7,7 +7,7 @@ module Nexmo
           file_path = if config['source'].starts_with? 'app/views'
                         config['source']
                       else
-                        "#{ENV['DOCS_BASE_PATH']}/#{config['source']}"
+                        "#{Nexmo::Markdown::Config.docs_base_path}/#{config['source']}"
                       end
           content = File.read(file_path)
     

data/lib/nexmo_markdown_renderer/filters/tab_filter.rb

@@ -8,9 +8,9 @@ module Nexmo
           @config = YAML.safe_load($3)
     
           if tabbed_folder?
-            raise "#{@config['source']} is not a directory" unless File.directory? "#{ENV['DOCS_BASE_PATH']}/#{@config['source']}"
+            raise "#{@config['source']} is not a directory" unless File.directory? "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
     
-            @tabbed_config = YAML.safe_load(File.read("#{ENV['DOCS_BASE_PATH']}/#{@config['source']}/.config.yml"))
+            @tabbed_config = YAML.safe_load(File.read("#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}/.config.yml"))
             @path = @config['source']
             validate_folder_config
           else
@@ -146,7 +146,7 @@ module Nexmo
       end
     
       def content_from_source
-        source_path = "#{ENV['DOCS_BASE_PATH']}/#{@config['source']}"
+        source_path = "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
         source_path += '/*' if tabbed_code_examples?
         source_path += '/*.md' if tabbed_content?
     
@@ -165,7 +165,7 @@ module Nexmo
       end
     
       def content_from_folder
-        source_path = "#{ENV['DOCS_BASE_PATH']}/#{@config['source']}"
+        source_path = "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
         source_path += '/*.md'
     
         files = Dir.glob(source_path)
@@ -182,9 +182,9 @@ module Nexmo
     
       def content_from_tabs
         @config['tabs'].map do |title, config|
-          raise "Could not find content_from_tabs file: #{ENV['DOCS_BASE_PATH']}/#{@config['source']}" unless File.exist? "#{ENV['DOCS_BASE_PATH']}/#{@config['source']}"
+          raise "Could not find content_from_tabs file: #{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}" unless File.exist? "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
     
-          source = File.read("#{ENV['DOCS_BASE_PATH']}/#{@config['source']}")
+          source = File.read("#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}")
     
           config.symbolize_keys.merge({
             id: SecureRandom.hex,

data/lib/nexmo_markdown_renderer/initializers/doc_finder.rb

@@ -1,5 +1,5 @@
 Nexmo::Markdown::DocFinder.configure do |config|
-  config.paths << "#{ENV['DOCS_BASE_PATH']}/_documentation"
-  config.paths << "#{ENV['DOCS_BASE_PATH']}/_use_cases"
-  config.paths << "#{ENV['DOCS_BASE_PATH']}/_tutorials"
+  config.paths << "#{Nexmo::Markdown::Config.docs_base_path}/_documentation"
+  config.paths << "#{Nexmo::Markdown::Config.docs_base_path}/_use_cases"
+  config.paths << "#{Nexmo::Markdown::Config.docs_base_path}/_tutorials"
 end

data/lib/nexmo_markdown_renderer/models/code_snippet.rb

@@ -64,7 +64,7 @@ module Nexmo
       end
     
       def self.origin
-        "#{ENV['DOCS_BASE_PATH']}/_documentation"
+        "#{Nexmo::Markdown::Config.docs_base_path}/_documentation"
       end
     end
     

data/lib/nexmo_markdown_renderer/models/concept.rb

@@ -2,8 +2,8 @@ module Nexmo
   module Markdown
     class Concept
       include ActiveModel::Model
-
-      ORIGIN = "#{ENV['DOCS_BASE_PATH']}/_documentation".freeze
+    
+      ORIGIN = "#{Nexmo::Markdown::Config.docs_base_path}/_documentation".freeze
 
       FILES = [
         Dir.glob("#{ORIGIN}/#{::I18n.default_locale}/**/guides/**/*.md"),

data/lib/nexmo_markdown_renderer/models/tutorial.rb

@@ -140,7 +140,7 @@ module Nexmo
       end
 
       def self.task_content_path
-        "#{ENV['DOCS_BASE_PATH']}/_tutorials"
+        "#{Nexmo::Markdown::Config.docs_base_path}/_tutorials"
       end
     end
 

data/lib/nexmo_markdown_renderer/models/use_case.rb

@@ -54,7 +54,7 @@ module Nexmo
       end
 
       def self.origin
-        Pathname.new("#{ENV['DOCS_BASE_PATH']}/_use_cases")
+        Pathname.new("#{Nexmo::Markdown::Config.docs_base_path}/_use_cases")
       end
 
       def self.all

data/lib/version.rb

@@ -1,7 +1,7 @@
 # :nocov:
 module Nexmo
   module Markdown
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end
 # :nocov:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -233,6 +233,7 @@ files:
 - config/dynamic_content.yml
 - config/locales/en.yml
 - lib/nexmo_markdown_renderer.rb
+- lib/nexmo_markdown_renderer/config/load_config.rb
 - lib/nexmo_markdown_renderer/core_ext/string.rb
 - lib/nexmo_markdown_renderer/filters/anchor_filter.rb
 - lib/nexmo_markdown_renderer/filters/audio_filter.rb
@@ -328,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.0
 signing_key: 
 specification_version: 4
 summary: Middleware to render Markdown Documents in Nexmo Developer Platform.