scrapbook 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca937f0e8c26f5b3ea2676b64135cf711e53ce2e17ac407c67abc7f934bfc482
-  data.tar.gz: 90069e6ac7f4e344b8a6f245dc8e8c2fc02c5b052df51fec6fea7cac7658c9e2
+  metadata.gz: 19b4fdaf3007e60e0cd40c09d70fe04ee9c9b522552dc0060f718aba02fcaadd
+  data.tar.gz: 015d92510a0e2eacff22b81d163983de1ff88d2bc60f7f523e69dbfbc841d591
 SHA512:
-  metadata.gz: d53088db3d75baeca477c9358ffe7c52483e9f13a370d5c1c4a021ec5017f5d0d108bea466d9194547bd6258852ca2e2b47b2dc468ef66126f784302d88be911
-  data.tar.gz: d337a10422bed9966cb1cba24fa8362b63a8f5afed5e16572dc13248679a0d993c122fd06972ff8fd89eed2257892698ec33052c4d8d6945cabfc9788507d361
+  metadata.gz: c23dc644bb467bd0655a781615095e6cb74fd7ccc47dc0281a1877089bf42617fae23cbc182d290b437f96669328a899cda705a7ea69c299df0fb9f0e58f39c3
+  data.tar.gz: 379b7626edd2752d95c039d6daaf947f668c0dc4a1571685b58879a11509987df0da474184a4f37896c1585135e0ea7bc7be9c044e80bc78385a2f0566c287dc

data/README.md

@@ -26,7 +26,7 @@ end
 
 And then execute:
 
-```bash
+```
 $> bundle install
 $> bundle exec rails generate scrapbook:install
 ```
@@ -70,12 +70,12 @@ 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
-    ```
+```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
@@ -85,17 +85,17 @@ We recommend only running Scrapbook in development / non-production Rails enviro
 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 +116,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 +130,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 +139,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/helpers/scrapbook/helper_for_view.rb

@@ -11,7 +11,11 @@ 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, '/')
+      if scrapbook.root == ::Scrapbook::Engine.config.scrapbook.paths.first
+        view.short_page_path(scrapbook.relative_page_path_for(pathname))
+      else
+        view.book_page_path(scrapbook.relative_page_path_for(pathname), book: scrapbook.name)
+      end
     end
 
     def remove_handler_exts_from(pathname)

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

@@ -5,8 +5,7 @@
   <%= 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/config/routes.rb

@@ -11,6 +11,6 @@ Scrapbook::Engine.routes.draw do
 
   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 ':book/*id', to: 'pages#show', constraints: {book: book_regex, id: /.*/}, as: :book_page
   get '*id', to: 'pages#show', constraints: {id: /.*/}, as: :short_page
 end

data/lib/generators/scrapbook/install_generator.rb

@@ -11,6 +11,16 @@ module Scrapbook
     def install
       generate 'scrapbook:routes', options.fetch('url-path')
       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/scrapbook/engine.rb

@@ -18,7 +18,7 @@ module Scrapbook
     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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrapbook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Brad Lindsay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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

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
- */