troy 0.0.35 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1de66b8776191039502385cfc1ca3453f4b9bc30ae81b0eefbc4a7257124ad30
-  data.tar.gz: 51fd07dbf2caac206263ed83fd0830d31f2326e30c3cec82796dcc578470d116
+  metadata.gz: 04b065e86e12781d992f5f023ff7aa6ca2595739841b9d96245d4ed76e5282b2
+  data.tar.gz: b2cff9bf95dc780b1a18a2de12a2dde3e756eb8b9e079027d8447039625472d0
 SHA512:
-  metadata.gz: 7c79d4c7ffc7976d1e7624e8432bcc450b178f45ae46ee06e896a5a501f60e0ca0eec0273853fe304e83e6ef245733e9856a3588453e46571130099c1cb07bda
-  data.tar.gz: 0d87cd79c7ef8e7be0383e5f6ff67788e06a9d3074c2d82e5e66a4ae20e2c26c259e268cbcd9c1fd0c9af740aa4fdb4be507d889f4b90a6652fc9eee97cc9010
+  metadata.gz: 8a0d318f8aa044bf7b6feef04ba2e613e5fc8bfd63cd4c29f247617cefbb8d4f3a7b084a29bbbd0f416e0b5604320da31036d82bb20ae5b225303bd5ac04166a
+  data.tar.gz: a0a1c0bb7658e7c92f8f98c086421ca83a00af30ba1f7a4c9aaa900549a580421f98f1f10298457d2f021d04213443adf09e5faea85983188022a313bd7c9844

data/.rubocop.yml

@@ -0,0 +1,83 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/Documentation:
+  Enabled: false
+
+Rails/Delegate:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: space
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%": "[]"
+    "%i": "[]"
+    "%q": "[]"
+    "%Q": "[]"
+    "%r": "{}"
+    "%s": "[]"
+    "%w": "[]"
+    "%W": "[]"
+    "%x": "[]"
+
+Metrics/LineLength:
+  Enabled: true
+
+Metrics/MethodLength:
+  Exclude:
+    - db/migrate/**.rb
+    - config/config.rb
+    - test/support/**/*.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - config/config.rb
+    - test/support/**/*.rb
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+Lint/Debugger:
+  Exclude:
+    - test/**/*
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+    PreferredName: error
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/lib/troy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Encoding.default_external = "UTF-8"
 Encoding.default_internal = "UTF-8"
 
@@ -14,7 +16,8 @@ require "rack"
 require "uglifier"
 require "html_press"
 
-level, $VERBOSE = $VERBOSE, nil
+level = $VERBOSE
+$VERBOSE = nil
 require "rouge"
 require "rouge/plugins/redcarpet"
 $VERBOSE = level

data/lib/troy/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   class Cli < Thor
     check_unknown_options!
@@ -25,15 +27,11 @@ module Troy
           site.export_files
         end
 
-        if options[:file]
-          options[:file].each do |file|
-            site.export_pages(file)
-          end
+        options[:file]&.each do |file|
+          site.export_pages(file)
         end
 
-        if !options[:assets] && !options[:file]
-          site.export
-        end
+        site.export if !options[:assets] && !options[:file]
       end
 
       if options[:benchmark]
@@ -53,14 +51,14 @@ module Troy
     end
 
     desc "version", "Display Troy version"
-    map %w(-v --version) => :version
+    map %w[-v --version] => :version
     def version
       say "Troy #{Troy::VERSION}"
     end
 
     desc "server", "Start a server"
-    option :port, :type => :numeric, :default => 9292, :aliases => "-p"
-    option :host, :type => :string, :default => "0.0.0.0", :aliases => "-b"
+    option :port, type: :numeric, default: 9292, aliases: "-p"
+    option :host, type: :string, default: "0.0.0.0", aliases: "-b"
     def server
       begin
         handler = Rack::Handler::Thin
@@ -69,12 +67,13 @@ module Troy
         handler = Rack::Handler::WEBrick
       end
 
-      handler.run Troy::Server.new(File.join(Dir.pwd, "public")), :Port => options[:port], :Host => options[:host]
+      handler.run Troy::Server.new(File.join(Dir.pwd, "public")), Port: options[:port], Host: options[:host]
     end
 
-    private
-    def site
-      @site ||= Troy::Site.new(Dir.pwd, options)
+    no_commands do
+      def site
+        @site ||= Troy::Site.new(Dir.pwd, options)
+      end
     end
   end
 end

data/lib/troy/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   ::I18n.enforce_available_locales = false
 
@@ -5,18 +7,18 @@ module Troy
     @configuration ||= Configuration.new
   end
 
-  def self.configure(&block)
+  def self.configure
     yield configuration
   end
 
   class Configuration < OpenStruct
     def assets
-      @assets ||= Configuration.new({
+      @assets ||= Configuration.new(
         compress_html: true,
         compress_css: true,
         compress_js: true,
         precompile: []
-      })
+      )
     end
 
     def i18n

data/lib/troy/context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   class Context
     def initialize(options = {})

data/lib/troy/embedded_ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   class EmbeddedRuby
     # The template content.

data/lib/troy/extension_matcher.rb

@@ -1,15 +1,11 @@
+# frozen_string_literal: true
+
 module Troy
   class ExtensionMatcher
-    #
-    #
     attr_reader :path
 
-    #
-    #
     attr_reader :performed
 
-    #
-    #
     attr_reader :matchers
 
     def initialize(path)
@@ -32,7 +28,7 @@ module Troy
         return handler.call if File.extname(path) == ext
       end
 
-      matchers["default"].call if matchers["default"]
+      matchers["default"]&.call
     end
   end
 end

data/lib/troy/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   # The Troy::Generator class will create a new book structure.
   #
@@ -11,7 +13,7 @@ module Troy
     desc "Generate a new site structure"
 
     def self.source_root
-      File.expand_path("../../../templates", __FILE__)
+      File.expand_path("../../templates", __dir__)
     end
 
     def create_directories

data/lib/troy/hacks.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 require "digest/sha1"
 
 module HtmlPress
-  CONTENT_CACHE = {}
+  def self.content_cache
+    @content_cache ||= {}
+  end
 
-  def self.js_compressor (text, options = nil)
+  def self.js_compressor(text, options = nil)
     options ||= {}
     options[:output] ||= {inline_script: true}
 
     hash = Digest::SHA1.hexdigest(text)
-    CONTENT_CACHE[hash] ||= MultiJs.compile(text, options).gsub(/;$/,'')
-    CONTENT_CACHE[hash]
+    content_cache[hash] ||= MultiJs.compile(text, options).gsub(/;$/, "")
+    content_cache[hash]
   end
 end

data/lib/troy/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   module Helpers
     def h(content)
@@ -20,7 +22,7 @@ module Troy
       path = site.root.join("partials/#{partial}")
       locals = locals.merge(site: site, page: page)
       EmbeddedRuby.new(path.read, locals).render
-    rescue Exception, StandardError => error
+    rescue Exception => error
       raise "Unable to render #{path}; #{error.message}"
     end
 

data/lib/troy/markdown.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   class Markdown
     # Create a new Redcarpet renderer, that prepares the code block
@@ -31,12 +33,11 @@ module Troy
     end
 
     def renderer
-      @renderer ||= Redcarpet::Markdown.new(Renderer, {
-        autolink: true,
-        space_after_headers: true,
-        fenced_code_blocks: true,
-        footnotes: true
-      })
+      @renderer ||= Redcarpet::Markdown.new(Renderer,
+                                            autolink: true,
+                                            space_after_headers: true,
+                                            fenced_code_blocks: true,
+                                            footnotes: true)
     end
 
     def to_html

data/lib/troy/meta.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Troy
   class Meta
     extend Forwardable
     def_delegators :data, :[], :fetch, :key?
 
-    REGEX = /^---\n(.*?)\n---\n+/m
+    REGEX = /^---\n(.*?)\n---\n+/m.freeze
 
     attr_reader :file
 
@@ -16,14 +18,15 @@ module Troy
     end
 
     def data
-      @data ||= (raw =~ REGEX ? YAML.load(raw[REGEX, 1]) : {})
+      @data ||=
+        raw =~ REGEX ? YAML.safe_load(raw[REGEX, 1], [Date, Time]) : {}
     end
 
-    def method_missing(name, *args, &block)
+    def method_missing(name, *_args)
       data[name.to_s]
     end
 
-    def respond_to_missing?(method, include_private = false)
+    def respond_to_missing?(_method, _include_private = false)
       true
     end
 

data/lib/troy/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   class Page
     extend Forwardable
@@ -27,33 +29,26 @@ module Troy
       @meta = meta || Meta.new(path)
     end
 
-    #
-    #
     def method_missing(name, *args, &block)
       return meta[name.to_s] if meta.key?(name.to_s)
+
       super
     end
 
-    #
-    #
-    def respond_to_missing?(name, include_private = false)
+    def respond_to_missing?(name, _include_private = false)
       meta.key?(name.to_s)
     end
 
-    #
-    #
     def content
       ExtensionMatcher.new(path)
-        .default { meta.content }
-        .on("builder") { XML.new(meta.content, to_context).to_xml }
-        .on("erb") { EmbeddedRuby.new(meta.content, to_context).render }
-        .on("md") { Markdown.new(meta.content).to_html }
-        .on("txt") { EmbeddedRuby.new(meta.content, to_context).render }
-        .match
+                      .default { meta.content }
+                      .on("builder") { XML.new(meta.content, to_context).to_xml }
+                      .on("erb") { EmbeddedRuby.new(meta.content, to_context).render }
+                      .on("md") { Markdown.new(meta.content).to_html }
+                      .on("txt") { EmbeddedRuby.new(meta.content, to_context).render }
+                      .match
     end
 
-    #
-    #
     def to_context
       {
         page: self,
@@ -61,8 +56,6 @@ module Troy
       }
     end
 
-    #
-    #
     def compress(content)
       content = HtmlPress.press(content) if config.assets.compress_html
       content
@@ -72,38 +65,30 @@ module Troy
     #
     def render
       ExtensionMatcher.new(path)
-        .default { content }
-        .on("html") { compress render_erb }
-        .on("md") { compress render_erb }
-        .on("erb") { compress render_erb }
-        .match
+                      .default { content }
+                      .on("html") { compress render_erb }
+                      .on("md") { compress render_erb }
+                      .on("erb") { compress render_erb }
+                      .match
     end
 
-    #
-    #
     def permalink
       meta.fetch("permalink", File.basename(path).gsub(/\..*?$/, ""))
     end
 
-    #
-    #
     def filename
       ExtensionMatcher.new(path)
-        .default { "#{permalink}.html" }
-        .on("builder") { "#{permalink}.xml" }
-        .on("xml") { "#{permalink}.xml" }
-        .on("txt") { "#{permalink}.txt" }
-        .match
+                      .default { "#{permalink}.html" }
+                      .on("builder") { "#{permalink}.xml" }
+                      .on("xml") { "#{permalink}.xml" }
+                      .on("txt") { "#{permalink}.txt" }
+                      .match
     end
 
-    #
-    #
     def layout
-      site.root.join("layouts/#{meta.fetch("layout", "default")}.erb")
+      site.root.join("layouts/#{meta.fetch('layout', 'default')}.erb")
     end
 
-    #
-    #
     def render_erb
       if layout.exist?
         EmbeddedRuby.new(
@@ -125,25 +110,19 @@ module Troy
       end
     end
 
-    #
-    #
     def output_file
       base = File.dirname(path)
-        .gsub(site.root.join("source").to_s, "")
-        .gsub(%r[^/], "")
+                 .gsub(site.root.join("source").to_s, "")
+                 .gsub(%r{^/}, "")
 
       site.root.join("public", base, filename)
     end
 
-    #
-    #
     def save
       FileUtils.mkdir_p(File.dirname(output_file))
       save_to(output_file)
     end
 
-    #
-    #
     def config
       Troy.configuration
     end

data/lib/troy/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   class Server
     attr_reader :root, :request
@@ -13,7 +15,9 @@ module Troy
 
     def render(status, content_type, path)
       last_modified = path.mtime.httpdate
-      return [304, {}, []] if request.env["HTTP_IF_MODIFIED_SINCE"] == last_modified
+      if request.env["HTTP_IF_MODIFIED_SINCE"] == last_modified
+        return [304, {}, []]
+      end
 
       headers = {
         "Content-Type" => content_type,
@@ -26,7 +30,7 @@ module Troy
     end
 
     def normalized_path
-      path = request.path.gsub(%r[/$], "")
+      path = request.path.gsub(%r{/$}, "")
       path << "?#{request.query_string}" unless request.query_string.empty?
       path
     end
@@ -36,7 +40,7 @@ module Troy
     end
 
     def process
-      path = request.path[%r[^/(.*?)/?$], 1]
+      path = request.path[%r{^/(.*?)/?$}, 1]
       path = "index" if path == ""
       path = root.join(path)
 

data/lib/troy/site.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   class Site
     attr_accessor :root, :options
@@ -11,30 +13,22 @@ module Troy
       set_locale
     end
 
-    #
-    #
     def load_extensions
       Dir[root.join("config/**/*helpers.rb")].each do |file|
         require file
       end
     end
 
-    #
-    #
     def set_locale
       I18n.load_path += config.i18n.load_path
       I18n.default_locale = config.i18n.locale
       I18n.locale = config.i18n.locale
     end
 
-    #
-    #
     def load_configuration
       load root.join("config/troy.rb")
     end
 
-    #
-    #
     def export
       remove_public_dir
       export_assets
@@ -42,8 +36,6 @@ module Troy
       export_pages
     end
 
-    #
-    #
     def export_files
       assets = root.join("assets")
 
@@ -57,18 +49,15 @@ module Troy
     def export_file(assets, entry)
       basename = entry.to_s
       return if [".", "..", "javascripts", "stylesheets"].include?(basename)
+
       FileUtils.rm_rf root.join("public/#{basename}")
       FileUtils.cp_r assets.join(entry), root.join("public/#{basename}")
     end
 
-    #
-    #
     def remove_public_dir
       FileUtils.rm_rf root.join("public")
     end
 
-    #
-    #
     def export_pages(file = nil)
       file = File.expand_path(file) if file
 
@@ -76,21 +65,27 @@ module Troy
         .select {|page| file.nil? || page.path == file }
         .each_slice(options[:concurrency]) do |slice|
           threads = slice.map do |page|
-            Thread.new { page.save }
+            Thread.new do
+              page.save
+            end
           end
 
           threads.each(&:join)
         end
     end
 
-    #
-    #
     def export_assets
       sprockets = Sprockets::Environment.new
       sprockets.append_path root.join("assets/javascripts")
       sprockets.append_path root.join("assets/stylesheets")
-      sprockets.css_compressor = Sprockets::SassCompressor if config.assets.compress_css
-      sprockets.js_compressor = Uglifier.new(uglifier_options) if config.assets.compress_js
+
+      if config.assets.compress_css
+        sprockets.css_compressor = Sprockets::SassCompressor
+      end
+
+      if config.assets.compress_js
+        sprockets.js_compressor = Uglifier.new(uglifier_options)
+      end
 
       config.assets.precompile.each_slice(options[:concurrency]) do |slice|
         slice.map do |asset_name|
@@ -101,26 +96,21 @@ module Troy
 
     def export_asset(sprockets, asset_name)
       asset = sprockets[asset_name]
-      output_file = asset.pathname.to_s
-        .gsub(root.join("assets").to_s, "")
-        .gsub(%r[^/], "")
-        .gsub(/\.scss$/, ".css")
-        .gsub(/\.coffee$/, ".js")
+      output_file = asset.filename.to_s
+                         .gsub(root.join("assets").to_s, "")
+                         .gsub(%r{^/}, "")
+                         .gsub(/\.scss$/, ".css")
+                         .gsub(/\.coffee$/, ".js")
 
       asset.write_to root.join("public/#{output_file}")
     end
 
-    #
-    #
-    #
     def uglifier_options
       options = Uglifier::DEFAULTS.dup
       options[:output][:comments] = :none
       options
     end
 
-    #
-    #
     def source
       Dir[root.join("source/**/*.{html,erb,md,builder,xml,txt}").to_s]
     end

data/lib/troy/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
-  VERSION = "0.0.35"
+  VERSION = "0.0.36"
 end

data/lib/troy/xml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Troy
   class XML
     # The XML content.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: troy
 version: !ruby/object:Gem::Version
-  version: 0.0.35
+  version: 0.0.36
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2019-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -215,6 +215,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -268,8 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A static site generator