scrapbook 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca937f0e8c26f5b3ea2676b64135cf711e53ce2e17ac407c67abc7f934bfc482
-  data.tar.gz: 90069e6ac7f4e344b8a6f245dc8e8c2fc02c5b052df51fec6fea7cac7658c9e2
+  metadata.gz: 215d5d39bc38386f6e2c7c08e2126e26718305961ae675a3b6d433b13ff5a4d9
+  data.tar.gz: 07662ed1539e36da1323a74fcb2f4314ea23546586d86036f90d60635b62c913
 SHA512:
-  metadata.gz: d53088db3d75baeca477c9358ffe7c52483e9f13a370d5c1c4a021ec5017f5d0d108bea466d9194547bd6258852ca2e2b47b2dc468ef66126f784302d88be911
-  data.tar.gz: d337a10422bed9966cb1cba24fa8362b63a8f5afed5e16572dc13248679a0d993c122fd06972ff8fd89eed2257892698ec33052c4d8d6945cabfc9788507d361
+  metadata.gz: 2f2c0d4853af4a8fa82f5a9175874c082932ee36eb9825eccfe1f733afa8bb01025feaa70811321d1f118392ef7803a3da9c0b7addf240967262d6a23171fd6c
+  data.tar.gz: e6e4215895e268d0bb554c1b7fa88ffb1f60e3e18ae2a8ed29fdd62762585ea6998ef582528a637bb2e55f8f3a048e6599732807bfc10ae8c1a899cbd2ea2120

data/README.md

@@ -26,13 +26,14 @@ end
 
 And then execute:
 
-```bash
+```
 $> bundle install
 $> bundle exec rails generate scrapbook:install
 ```
 
-This will install the gem and setup the default Scrapbook route and create the default
-scrapbook directory structure at the root of your Rails application.
+This will install the gem and then setup a scrapbook directory structure with a folder named
+"scrapbook" at the root of your Rails application as well as modify your routes to make the
+scrapbook available.
 
 ## Usage
 
@@ -48,54 +49,48 @@ the main display area describing how to customize what is displayed when a folde
 selected. In short, you need to create a template file with the same base name as the folder
 in the same directory as the folder. So if you had a folder at "scrapbook/pages/scratch",
 then you would need to create a file named something like "scrapbook/pages/scratch.html.erb"
-with the custom display you want to see when you click on the "scratch" folder in the file
+with the custom view you want to see when you click on the "scratch" folder in the file
 browser. This also works for the main screen you see at the base scrapbook URL. You can
 customize that screen by creating a "pages.html" template file in the root scrapbook folder.
 (The default installation creates a "pages.html.erb" template file for the basic welcome
 message.)
 
-To view a scrapbook, navigate to its base URL. The default scarpbook can always be accessed
-at the mountpoint setup in the routes file (this is "/scrapbook" by default). The base URL
-for other scrapbooks is that path followed by the name of the scrapbook's root folder (the
-folder that contains the "pages" folder). By default, only one scrapbook is configured and
-it's name is "scrapbook" which means that both "/scrapbook" and "/scrapbook/scrapbook" point
-to the same scrapbook root page.
+To view a scrapbook, navigate to its base URL setup by the route file configuration. (See
+the documentation for the `scrapbook` route helper for more information on how to conigure
+this route.)
 
 ## Configuration
 
-You can configure the path that Scrapbook runs on in your "config/routes.rb" file. The
-default configuration is to mount Scrapbook on "/scrapbook", but you can use whatever
-path you want: `mount Scrapbook::Engine => "/scrappy"`.
-
-You can configure one or more folders to be separate root scrapbooks via the
-`config.scrapbook.paths` option. This option defaults to an empty array which allows for
-using the shovel operator to add your paths:
-    ```ruby
-    Rails.application.configure do
-      config.scrapbook.paths << Rails.root.join("scrapbooks/main")
-      config.scrapbook.paths << Rails.root.join("scrapbooks/scratch")
-    end
-    ```
-If no paths have been added, Scrapbook will use `Rails.root.join('scrapbook')` as the
-location it expects the scrapbook to be at. The first folder path in the array is considered
-the default scrapbook and will be available at the root mount point configured in the routes
-file.
+The installation task adds `extend Scrapbook::Routing` to the routes configuration block
+which gives it access to the `scrapbook` route helper. It also addds a scrapbook named
+"scrapbook" using that helper (`scrapbook('scrapbook')`). You can modify that configuration,
+specifying the location of the folder root or the URL path to mount the scrapbook at. You
+can also add additional scrapbooks using this helper. For example:
+
+```ruby
+Rails.application.routes.draw do
+  extend Scrapbook::Routing
+
+  scrapbook('main', at: '/scrapbook', folder_root: 'scrapbooks/main')
+  scrapbook('scratch', folder_root: 'scrapbooks/scratch')
+end
+```
 
 We recommend only running Scrapbook in development / non-production Rails environments.
 However, if you find yourself needing to be able to run it in an environment precompiles its
 assets, you will need to configure Scrapbook to be part of the precompilation. You can do
 this by setting `config.scrapbook.precompile_assets` to "true":
-    ```ruby
-    Rails.application.configure do
-      config.scrapbook.precompile_assets = true
-    end
-    ```
+```ruby
+Rails.application.configure do
+  config.scrapbook.precompile_assets = true
+end
+```
 
 
 ## Contributing
 
-If you have a question about Scrapbook, feel free to ask in [the repository's Discussions]
-[Discussions]. Before starting any work or creating any issues, please read [the
+If you have a question about Scrapbook, feel free to ask in [the repository's
+Discussions][Discussions]. Before starting any work or creating any issues, please read [the
 contribution guidelines](CONTRIBUTING.md).
 
 ## Development Setup
@@ -116,7 +111,7 @@ Once Tailwind's CLI has been installed, you can run it using the command below t
 Scrapbook's CSS:
 
 ```
-$> npx tailwindcss -i app/assets/stylesheets/scrapbook/application.tailwind.css -o app/assets/builds/scrapbook/tailwind.css --minify --watch
+$> npx tailwindcss -i app/assets/stylesheets/scrapbook/application.tailwind.css -o app/assets/builds/scrapbook/application.css --minify --watch
 ```
 
 (Note, the "tailwindcss-rails" gem currently doesn't support Rails engines, so we have to
@@ -130,7 +125,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+[http://www.apache.org/licenses/LICENSE-2.0]()
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -139,4 +134,4 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 
-[Discussion]: https://github.com/bfad/scrapbook/discussions
+[Discussions]: https://github.com/bfad/scrapbook/discussions

data/app/controllers/scrapbook/pages_controller.rb

@@ -5,42 +5,30 @@ module Scrapbook
   class PagesController < ApplicationController
     self.view_paths = Engine.config.paths['app/views'].to_a
 
-    def index
-      return head(:not_found) if (scrapbook = find_scrapbook).nil?
-      return head(:not_found) unless (pathname = calculate_pathname(scrapbook, params[:path])).directory?
-
-      if pathname == scrapbook.pages_pathname
-        prepend_view_path(scrapbook.root)
-        render template: 'pages', locals: {scrapbook: scrapbook, pathname: pathname}
-      else
-        render locals: {scrapbook: scrapbook, pathname: pathname}
-      end
-    end
-
     def show
       return head(:not_found) if (scrapbook = find_scrapbook).nil?
 
       pathname = calculate_pathname(scrapbook, params[:id])
-      template = params[:id].delete_suffix('.html')
+      template = calculate_template
 
-      if !scrapbook_template_exists?(scrapbook, template) && pathname.directory?
-        render 'scrapbook/pages/index', locals: {scrapbook: scrapbook, pathname: pathname}
-      else
-        render locals: {scrapbook: scrapbook, pathname: pathname}, formats: [:html]
-      end
+      render locals: {scrapbook: scrapbook, pathname: pathname}, formats: [:html]
     end
 
     def raw
       return head(:not_found) if (scrapbook = find_scrapbook).nil?
 
       pathname = calculate_pathname(scrapbook, params[:id])
-      template = params[:id].delete_suffix('.html')
+      template = calculate_template
 
       if scrapbook_template_exists?(scrapbook, template)
-        prepend_view_path(scrapbook.pages_pathname)
+        prepend_view_path(scrapbook.root)
         render template: template,
           locals: {scrapbook: scrapbook, pathname: pathname},
           layout: 'layouts/scrapbook/host_application'
+      elsif pathname.directory?
+        render '/pages',
+          locals: {scrapbook: scrapbook, pathname: pathname},
+          layout: 'layouts/scrapbook/host_application'
       elsif pathname.exist?
         render file: pathname
       else
@@ -51,25 +39,31 @@ module Scrapbook
     private
 
     def find_scrapbook
-      scrapbook_path = if params[:book].present?
-        ::Scrapbook::Engine.config.scrapbook.paths.find { File.basename(_1) == params[:book] }
-      else
-        ::Scrapbook::Engine.config.scrapbook.paths.first
-      end
+      return nil if book_name.blank?
 
+      scrapbook_path = Engine.config.scrapbook.paths[book_name]
       scrapbook_path && Scrapbook.new(scrapbook_path)
     end
 
     def calculate_pathname(scrapbook, path)
-      if path.present?
-        scrapbook.pages_pathname.join(path)
-      else
-        scrapbook.pages_pathname
-      end
+      scrapbook.pages_pathname.join(path || '')
+    end
+
+    def calculate_template
+      return 'pages' if params[:id].blank?
+
+      "pages/#{params[:id].delete_suffix('.html')}"
     end
 
     def scrapbook_template_exists?(scrapbook, template)
-      EmptyController.new.tap { |c| c.prepend_view_path(scrapbook.pages_pathname) }.template_exists?(template)
+      # It's deprecated, but Rails 6 allows for templates to be specified with extensions.
+      return false if Rails.version.to_i == 6 && template.include?('.')
+
+      EmptyController.new.tap { |c| c.prepend_view_path(scrapbook.root) }.template_exists?(template)
+    end
+
+    def book_name
+      params[:'.book']
     end
   end
 end

data/app/helpers/scrapbook/helper_for_view.rb

@@ -10,8 +10,7 @@ module Scrapbook
 
     def short_path_to(pathname, scrapbook = nil)
       scrapbook ||= Scrapbook.find_scrapbook_for(pathname)
-
-      view.short_page_path(scrapbook.relative_page_path_for(pathname)).gsub(/%2F/i, '/')
+      view.short_page_path(scrapbook.relative_page_path_for(pathname))
     end
 
     def remove_handler_exts_from(pathname)

data/app/models/scrapbook/scrapbook.rb

@@ -9,11 +9,11 @@ module Scrapbook
 
     def self.find_scrapbook_for(pathname)
       scrapbooks = ::Scrapbook::Engine.config.scrapbook.paths
-      candidates = scrapbooks.each_with_index.filter_map do |pname, index|
+      candidates = scrapbooks.filter_map do |book, pname|
         relative_path = pathname.relative_path_from(pname)
         next if relative_path.to_s.start_with?('..')
 
-        [index, relative_path.each_filename.count]
+        [book, relative_path.each_filename.count]
       end
       raise NotFoundError if candidates.empty?
 
@@ -25,7 +25,7 @@ module Scrapbook
     end
 
     def name
-      root.basename
+      root.basename.to_s
     end
 
     def pages_pathname

data/app/views/layouts/scrapbook/application.html.erb

@@ -1,12 +1,11 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title><%= local_assigns[:scrapbook].name || 'Scrapbook' %>: <%= content_for?(:title) ? yield(:title) : local_assigns[:pathname].basename %></title>
+  <title><%= local_assigns[:scrapbook]&.name || 'Scrapbook' %>: <%= content_for?(:title) ? yield(:title) : local_assigns[:pathname]&.basename %></title>
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
-  <%= stylesheet_link_tag "scrapbook/tailwind", "data-turbo-track": "reload" %>
-  <%= stylesheet_link_tag "scrapbook/application", media: "all" %>
+  <%= stylesheet_link_tag "scrapbook/application", media: "all", "data-turbo-track": "reload" %>
 </head>
 <body class="flex">
   <nav class="flex-none min-w-[20ch] max-w-[50%] h-screen overflow-scroll children:px-4 py-2 border-solid border-sky-700 border-0 border-r"><%= render 'layouts/scrapbook/folder_listing', scrapbook: local_assigns[:scrapbook], pathname: local_assigns[:pathname] %></nav>

data/app/views/pages.html.erb

@@ -1 +1,2 @@
-This directory has no corresponding template. You can add a template named "pages" to the Scrapbook root directory and its contents will show up here.
+<% if pathname == scrapbook.pages_pathname %>This directory has no corresponding template. You can add a template named "pages" to the Scrapbook root directory and its contents will show up here.
+<% else %>This directory has no corresponding template. You can add a template with the same name as the directory as a sibling to the directory and its contents will show up here.<% end %>

data/app/views/scrapbook/pages/show.html.erb

@@ -1 +1 @@
-<iframe src="<%= raw_page_path(book: scrapbook.name, id: scrapbook.relative_page_path_for(pathname)) %>" class="w-full h-full"></iframe>
+<iframe src="<%= raw_page_path(scrapbook.relative_page_path_for(pathname)) %>" class="w-full h-full"></iframe>

data/config/routes.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
 Scrapbook::Engine.routes.draw do
-  book_regex = /#{Scrapbook::Engine.config.scrapbook.paths.map { File.basename(_1) }.join('|')}/
+  # TODO: Future plans
+  # scope path: '/.editor' do
+  #   resources :pages, id: /.+/, only: %i[new create edit update]
+  # end
 
-  resources :pages, id: /.+/
-  resources :pages, path: ':book/pages', id: /.+/, constraints: {book: book_regex}
+  root 'pages#show'
 
-  get ':book', to: 'pages#index', constraints: {book: book_regex}
-  root 'pages#index'
-
-  get '.raw/:book/pages/*id', to: 'pages#raw', as: :raw_page,
-    constraints: {book: book_regex, id: /.*/}, defaults: {raw: true}
-  get ':book/*id', to: 'pages#show', constraints: {book: book_regex, id: /.*/}
+  get '.raw/pages(/*id)', to: 'pages#raw', constraints: {id: /.*/}, as: :raw_page
   get '*id', to: 'pages#show', constraints: {id: /.*/}, as: :short_page
 end

data/lib/generators/scrapbook/install_generator.rb

@@ -5,12 +5,23 @@ require 'rails/generators'
 module Scrapbook
   # Initial default setup of Scrapbook
   class InstallGenerator < Rails::Generators::Base
-    class_option 'url-path', default: '/scrapbook'
     class_option 'path-with-name', default: 'scrapbook'
 
     def install
-      generate 'scrapbook:routes', options.fetch('url-path')
+      name = Pathname.new(options.fetch('path-with-name')).basename.to_s
+
+      generate 'scrapbook:routes', name
       generate 'scrapbook:new', options.fetch('path-with-name')
+      sprockets_support
+    end
+
+    private
+
+    def sprockets_support
+      relative_path = 'app/assets/config/manifest.js'
+      return unless FileTest.exist?(File.expand_path(relative_path, destination_root))
+
+      insert_into_file(relative_path, '//= link scrapbook/application.css')
     end
   end
 end

data/lib/generators/scrapbook/routes_generator.rb

@@ -3,19 +3,21 @@
 require 'rails/generators'
 
 module Scrapbook
-  # A generator to create a new scrapbook at either the default (scrapbook) or specified
-  # path from the Rails application root.
+  # A generator to create a new scrapbook with  either the default (scrapbook) or specified
+  # name. (Using the default options for the URL path and folder root.)
   class RoutesGenerator < Rails::Generators::Base
-    argument :path, optional: true, default: '/scrapbook'
+    argument :name, optional: true, default: 'scrapbook'
 
     def routes
       # TODO: Investigate using a Rubocop rule to determine using single or double auotes.
-      url_path = path.start_with?('/') ? path : "/#{path}"
-      route <<~ROUTES
-        if Rails.env.development?
-          mount Scrapbook::Engine => '#{url_path}'
-        end
-      ROUTES
+
+      inject_into_file('config/routes.rb', after: "Rails.application.routes.draw do\n") do
+        "  extend Scrapbook::Routing\n"
+      end
+
+      inject_into_file('config/routes.rb', after: "extend Scrapbook::Routing\n") do
+        "\n  scrapbook('#{name}') if Rails.env.development?\n"
+      end
     end
   end
 end

data/lib/scrapbook/engine.rb

@@ -6,19 +6,13 @@ module Scrapbook
     isolate_namespace Scrapbook
 
     config.scrapbook = ActiveSupport::OrderedOptions.new
-    config.scrapbook.paths ||= []
+    config.scrapbook.paths ||= {}
     config.scrapbook.precompile_assets = config.scrapbook.precompile_assets || false
 
-    initializer 'scrapbook.configuration' do |app|
-      settings = app.config.scrapbook
-
-      settings.paths << Rails.root.join('scrapbook') if settings.paths.empty?
-    end
-
     initializer 'scrapbook.assets' do |app|
       if app.config.scrapbook.precompile_assets && app.config.respond_to?(:assets)
         app.config.assets.precompile.concat %w[
-          scrapbook/tailwind.css
+          scrapbook/application.css
         ]
       end
     end

data/lib/scrapbook/routing.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  # This is a helper method for making it easier to add scrapbooks to routes.
+  module Routing
+    def scrapbook(name, at: "/#{name}", folder_root: name)
+      folder_root = Pathname.new(folder_root)
+      folder_root = Rails.root.join(folder_root) if folder_root.relative?
+
+      Engine.config.scrapbook.paths[name] = folder_root
+      mount Engine => at, defaults: {'.book': name}, as: "#{name}_scrapbook"
+    end
+  end
+end

data/lib/scrapbook/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scrapbook
-  VERSION = '0.2.0'
+  VERSION = '0.2.2'
 end

data/lib/scrapbook.rb

@@ -2,6 +2,7 @@
 
 require 'scrapbook/version'
 require 'scrapbook/engine'
+require 'scrapbook/routing'
 
 # TODO: Figure out documentation
 # Placeholder

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrapbook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Brad Lindsay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
@@ -41,9 +41,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/assets/builds/scrapbook/tailwind.css
+- app/assets/builds/scrapbook/application.css
 - app/assets/config/scrapbook_manifest.js
-- app/assets/stylesheets/scrapbook/application.css
 - app/assets/stylesheets/scrapbook/application.tailwind.css
 - app/controllers/scrapbook/application_controller.rb
 - app/controllers/scrapbook/empty_controller.rb
@@ -57,7 +56,6 @@ files:
 - app/views/layouts/scrapbook/application.html.erb
 - app/views/layouts/scrapbook/host_application.html.erb
 - app/views/pages.html.erb
-- app/views/scrapbook/pages/index.html.erb
 - app/views/scrapbook/pages/show.html.erb
 - config/routes.rb
 - lib/generators/scrapbook/install_generator.rb
@@ -65,6 +63,7 @@ files:
 - lib/generators/scrapbook/routes_generator.rb
 - lib/scrapbook.rb
 - lib/scrapbook/engine.rb
+- lib/scrapbook/routing.rb
 - lib/scrapbook/version.rb
 - lib/tasks/scrapbook_tasks.rake
 homepage: https://bfad.github.io/scrapbook

data/app/assets/stylesheets/scrapbook/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/views/scrapbook/pages/index.html.erb

@@ -1 +0,0 @@
-This directory has no corresponding template. You can add a template with the same name as the directory as a sibling to the directory and its contents will show up here.