foxpage 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8037f2e78043aa067766f40fff0d279c4c6b94e205656d3897ea4fa820120928
-  data.tar.gz: c38fa73ab21a672d01ac81de9131e7855805cadbde981a46a97fc5b891f6d8c8
+  metadata.gz: 84f229830488de3f95f26f293faa0e3d6bf69c059ead7382f208e54ec9c622e6
+  data.tar.gz: a982959f7ef4f166fdc65ae444df3f7b59aec8e586325b2d518fc45386d860b9
 SHA512:
-  metadata.gz: d100781bd93a0f7c5900f8f8a0fc062a0d4ff42459af50d8b36684b089ff68774a739458e492824079bf8bbd108bedf88d1d2b3aabe8118480db89ef3c7dd60e
-  data.tar.gz: 938431d7c2787a57c3f31187b6fafc0259f6bde44e8e4e8216af2255c7ca12c2610304fbdf8648b9ed4198b6eb03c5228224994b85068f97725fd67fde1082fe
+  metadata.gz: c0770385e7c0d26c57a4c1d37ef8a379cf487474bacd7a168b667751ff6aced0ec5c540972c41fa6df86c599c8bf6d2b4f0fc7def5dccb33a646240fb3787b30
+  data.tar.gz: 6109f56f41c850d0d1ece8de71ccbfac29d0363a407a1c2538528d5ad3e46cc4eea81af3df4840c8b8581a534d675b1538193563cd2e34293eb8b3ff2d001ea0

data/.rubocop.yml

@@ -1,6 +1,6 @@
 ---
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.2
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.3
+3.2.0

data/Gemfile.lock

@@ -1,81 +1,89 @@
 PATH
   remote: .
   specs:
-    foxpage (0.2.2)
-      haml (~> 5.1)
-      listen (~> 3.1)
-      sassc (~> 2.0)
-      sprockets (~> 4.0.0.beta9)
-      thor (~> 0.20)
+    foxpage (1.0.0)
+      haml (~> 6.1)
+      listen (~> 3.7)
+      sassc (~> 2.4)
+      sprockets (~> 4.2)
+      thor (~> 1.2)
       tilt (~> 2.0)
-      webrick (~> 1.4)
-      zeitwerk (~> 2.1)
+      webrick (~> 1.7)
+      zeitwerk (~> 2.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    ffi (1.11.1)
-    haml (5.1.2)
-      temple (>= 0.8.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    haml (6.1.1)
+      temple (>= 0.8.2)
+      thor
       tilt
-    jaro_winkler (1.5.2)
-    listen (3.2.0)
+    json (2.6.3)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    rack (2.0.7)
-    rainbow (3.0.0)
-    rake (12.3.2)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rack (3.0.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.68.1)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.42.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.1)
-    sassc (2.2.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    sassc (2.4.0)
       ffi (~> 1.9)
-    sprockets (4.0.0)
+    sprockets (4.2.0)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    temple (0.8.2)
-    thor (0.20.3)
-    tilt (2.0.10)
-    unicode-display_width (1.5.0)
-    webrick (1.5.0)
-    zeitwerk (2.2.1)
+      rack (>= 2.2.4, < 4)
+    temple (0.9.1)
+    thor (1.2.1)
+    tilt (2.0.11)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  bundler (~> 2.4)
   foxpage!
-  rake (~> 12.3)
-  rspec (~> 3.0)
-  rubocop (~> 0.68.1)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.42)
 
 BUNDLED WITH
-   2.0.1
+   2.4.2

data/foxpage.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = "A very overengineered static-page generator"
   spec.homepage      = "https://github.com/nilsding/foxpage"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
 
   if spec.respond_to?(:metadata)
     spec.metadata["homepage_uri"] = spec.homepage
@@ -37,23 +38,23 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # core
-  spec.add_dependency "thor", "~> 0.20"
-  spec.add_dependency "zeitwerk", "~> 2.1"
+  spec.add_dependency "thor", "~> 1.2"
+  spec.add_dependency "zeitwerk", "~> 2.6"
 
   # templating
-  spec.add_dependency "haml", "~> 5.1"
+  spec.add_dependency "haml", "~> 6.1"
   spec.add_dependency "tilt", "~> 2.0"
 
   # assets
-  spec.add_dependency "sassc", "~> 2.0"
-  spec.add_dependency "sprockets", "~> 4.0.0.beta9"
+  spec.add_dependency "sassc", "~> 2.4"
+  spec.add_dependency "sprockets", "~> 4.2"
 
   # interactive development server
-  spec.add_dependency "listen", "~> 3.1"
-  spec.add_dependency "webrick", "~> 1.4"
+  spec.add_dependency "listen", "~> 3.7"
+  spec.add_dependency "webrick", "~> 1.7"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 0.68.1"
+  spec.add_development_dependency "bundler", "~> 2.4"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rubocop", "~> 1.42"
 end

data/lib/fox_page/app_template/__dot__rubocop.yml.tt

@@ -1,6 +1,6 @@
 ---
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.2
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/lib/fox_page/app_template/config/routes.rb.tt

@@ -4,9 +4,9 @@ App.draw_routes do
   # This defines the landing page of your website.
   root "home#index"
 
-  # Additional routes can be created by using `map`.
-  # For example to map `/projects` to the index method of ProjectsController,
+  # Additional routes can be created by using `route`.
+  # For example to route `/projects` to the index method of ProjectsController,
   # you can do this:
   #
-  # map "/projects" => "projects#index"
+  # route "/projects", to: "projects#index"
 end

data/lib/fox_page/builders/pages.rb

@@ -3,6 +3,12 @@
 require "tilt"
 require "fileutils"
 
+# Haml >= 6 ships its own template, so let the old Tilt version know about it.
+require "haml"
+Tilt::HamlTemplate = Haml::Template
+# use old default from Haml 5
+Haml::Template.options[:escape_html] = false
+
 module FoxPage
   module Builders
     module Pages
@@ -30,9 +36,16 @@ module FoxPage
           end
 
         enumerable.each_with_index do |item, index|
-          id = (item.respond_to?(:id) && item.id) || index
-          # have page numbers start with 1
-          target_path = format(path, id: id == index ? id + 1 : id)
+          if route.generate_all_ids
+            # generate_all returns ids
+            id = enumerable.at(index)
+            target_path = format(path, id: id)
+          else
+            id = (item.respond_to?(:id) && item.id) || index
+            # have page numbers start with 1
+            target_path = format(path, id: id == index ? id + 1 : id)
+          end
+
           build_single_page(target_path, route, id: id)
         end
       end
@@ -83,6 +96,7 @@ module FoxPage
           klass.include(Helpers::AppHelper.new(app))
           klass.include(Helpers::AssetsHelper)
           klass.include(Helpers::RenderHelper)
+          klass.include(Helpers::TagHelper)
 
           # include global ApplicationHelper if possible
           begin

data/lib/fox_page/controller.rb

@@ -21,14 +21,20 @@ module FoxPage
       @__generate_all = model
     end
 
+    # Set this to true if `generate_all` returns IDs (i.e. urls)
+    def self.generate_all_ids(generate_all_ids)
+      @__generate_all_ids = generate_all_ids
+    end
+
     def self.use_layout(layout)
       @__use_layout = layout
     end
 
     def self.method_added(method_name)
-      return unless @__generate_all.nil? || @__use_layout.nil?
+      return unless @__generate_all.nil? || @__use_layout.nil? || @__generate_all_ids.nil?
 
       set_method_option(method_name, "generate_all")
+      set_method_option(method_name, "generate_all_ids")
       set_method_option(method_name, "use_layout")
     end
 

data/lib/fox_page/helpers/tag_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module FoxPage
+  module Helpers
+    module TagHelper
+      class TagBuilder
+        def initialize(name:, content: nil, options: {})
+          @name = name
+          @content = content
+          @options = options
+        end
+
+        def build
+          [
+            "<",
+            [
+              @name.to_s,
+              *@options.compact.map(&method(:tag_option)),
+            ].join(" "),
+            ">",
+            @content,
+            "</",
+            @name.to_s,
+            ">"
+          ].join("")
+        end
+
+        private def tag_option(key, value)
+          value = value.gsub('"', "&quot;") if value.include? '"'
+          [key, %("#{value}")].join("=")
+        end
+      end
+
+      def content_tag(name, content_or_options_with_block = nil, options = nil, &block)
+        content = content_or_options_with_block
+        if block_given?
+          options = content_or_options_with_block
+          content = block.call
+        end
+        options ||= {}
+
+        TagBuilder.new(name:, content:, options:).build
+      end
+    end
+  end
+end

data/lib/fox_page/model.rb

@@ -72,7 +72,7 @@ module FoxPage
           front_matter = {}
           if content =~ /\A(---\n.*\n)^(?:---)\s*$\n?/m
             content = Regexp.last_match.post_match
-            front_matter = YAML.safe_load(Regexp.last_match[1], [Time])
+            front_matter = YAML.safe_load(Regexp.last_match[1], permitted_classes: [Time])
           end
 
           new front_matter.merge(id: id, content: content).to_deep_ostruct
@@ -155,7 +155,13 @@ module FoxPage
           value_key_name = "__#{key}_value"
           key = value_key_name if object.respond_to?(value_key_name)
 
-          object.public_send(key) == value
+          returned_value = object.public_send(key)
+          case returned_value
+          when Array
+            returned_value.include?(value)
+          else
+            returned_value == value
+          end
         end
       end
     end

data/lib/fox_page/router.rb

@@ -25,12 +25,38 @@ module FoxPage
       routes["/"] = parse_target(target, params: params)
     end
 
-    def map(mapping, params: {}, single_file: false)
+    # compatibility method for old route definition syntax
+    #
+    # `def map(mapping, params: {}, single_file: false)`
+    #
+    # see Router#route for the new style
+    #
+    # example DEPRECATED usage:
+    #   map "/uses" => "uses#index"
+    def map(*args)
+      warn "Router#map is deprecated, use Router#route instead"
+
+      mapping = args.shift
+      rest = args.shift || {}
+      params = rest.fetch(:params, {})
+      single_file = rest.fetch(:single_file, false)
+      pp(
+        mapping:, params:, single_file:,
+      )
+
       mapping.each do |path, target|
         routes[path] = parse_target(target, params: params, single_file: single_file)
       end
     end
 
+    # defines a new route
+    #
+    # example usage:
+    #   route "/uses", to: "uses#index"
+    def route(source, to:, params: {}, single_file: false)
+      routes[source] = parse_target(to, params: params, single_file: single_file)
+    end
+
     RESOURCE_ACTIONS = %i[index show].freeze
 
     def resources(name, path: name, only: RESOURCE_ACTIONS)
@@ -40,7 +66,7 @@ module FoxPage
       base_path = "/#{path}"
 
       # insert a route with id 0 as index if generate_all was specified, but without the /id in the path
-      if actions.find(:index)
+      if actions.include?(:index)
         validate_controller_method(controller, :index)
 
         routes[base_path] = make_target(
@@ -48,7 +74,8 @@ module FoxPage
           controller: controller,
           method_name: :index,
           params: { id: 0 },
-          generate_all: nil
+          generate_all: nil,
+          generate_all_ids: false
         )
       end
 
@@ -57,11 +84,16 @@ module FoxPage
         validate_controller_method(controller, method_name)
 
         generate_all = controller.instance_variable_get(:@__generate_all_for)&.[](method_name)
+        generate_all_ids = controller.instance_variable_get(:@__generate_all_ids_for)&.[](method_name)
 
         route_path = method_name == :index ? base_path : "#{base_path}/#{method_name}"
         if generate_all
           # :show gets a pretty id, whereas :index (and others) get it prefixed with /page
-          route_path = method_name == :show ? "#{base_path}/%<id>s" : "#{route_path}/page/%<id>s"
+          route_path = if generate_all_ids
+                         "#{base_path}/%<id>s"
+                       else
+                         method_name == :show ? "#{base_path}/%<id>s" : "#{route_path}/page/%<id>s"
+                       end
         end
 
         routes[route_path] ||= make_target(
@@ -69,7 +101,8 @@ module FoxPage
           controller: controller,
           method_name: method_name,
           params: {},
-          generate_all: generate_all
+          generate_all: generate_all,
+          generate_all_ids: generate_all_ids
         )
       end
     end
@@ -102,13 +135,14 @@ module FoxPage
       raise ArgumentError, "#{controller} does not define ##{method_name}"
     end
 
-    def make_target(base_name:, controller:, method_name:, params: {}, generate_all: nil, single_file: false)
+    def make_target(base_name:, controller:, method_name:, params: {}, generate_all: nil, generate_all_ids: false, single_file: false)
       OpenStruct.new(
         base_name: base_name,
         controller: controller,
         method_name: method_name,
         params: OpenStruct.new(params),
         generate_all: generate_all,
+        generate_all_ids: generate_all_ids,
         single_file: single_file
       )
     end

data/lib/fox_page/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FoxPage
-  VERSION = "0.2.2"
+  VERSION = "1.0.0"
 end

data/lib/fox_page.rb

@@ -4,6 +4,7 @@ require "bundler"
 
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/foxpage.rb")
 begin
   loader.ignore Bundler.root
 rescue Bundler::GemfileNotFound # rubocop:disable Lint/HandleExceptions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foxpage
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Georg Gadinger
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-22 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -72,112 +72,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta9
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta9
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: '1.42'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: '1.42'
 description: A very overengineered static-page generator
 email:
 - nilsding@nilsding.org
@@ -238,6 +238,7 @@ files:
 - lib/fox_page/helpers/app_helper.rb
 - lib/fox_page/helpers/assets_helper.rb
 - lib/fox_page/helpers/render_helper.rb
+- lib/fox_page/helpers/tag_helper.rb
 - lib/fox_page/model.rb
 - lib/fox_page/refinements/camelize.rb
 - lib/fox_page/refinements/constantize.rb
@@ -258,7 +259,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/nilsding/foxpage
   source_code_uri: https://github.com/nilsding/foxpage
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -266,15 +267,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.2
+signing_key:
 specification_version: 4
 summary: A Rails-like static page generator
 test_files: []