scrapbook 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca937f0e8c26f5b3ea2676b64135cf711e53ce2e17ac407c67abc7f934bfc482
+  data.tar.gz: 90069e6ac7f4e344b8a6f245dc8e8c2fc02c5b052df51fec6fea7cac7658c9e2
+SHA512:
+  metadata.gz: d53088db3d75baeca477c9358ffe7c52483e9f13a370d5c1c4a021ec5017f5d0d108bea466d9194547bd6258852ca2e2b47b2dc468ef66126f784302d88be911
+  data.tar.gz: d337a10422bed9966cb1cba24fa8362b63a8f5afed5e16572dc13248679a0d993c122fd06972ff8fd89eed2257892698ec33052c4d8d6945cabfc9788507d361

data/LICENSE.txt

@@ -0,0 +1,202 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+    To apply the Apache License to your work, attach the following
+    boilerplate notice, with the fields enclosed by brackets "[]"
+    replaced with your own identifying information. (Don't include
+    the brackets!)  The text should be enclosed in the appropriate
+    comment syntax for the file format. We also recommend that a
+    file or class name and description of purpose be included on the
+    same "printed page" as the copyright notice for easier
+    identification within third-party archives.
+
+
+Copyright 2022 Brad Lindsay
+
+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
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.

data/README.md

@@ -0,0 +1,142 @@
+# Scrapbook
+
+Scrapbook allows you to create a heirarchal set of view templates that can run code from
+your Rails application without the need to create a route or controller for each template.
+All you need to do is install and configure Scrapbook, and then you can add folders and
+template files to your heart's content.
+
+Scrapbook started life wanting to be able to test out Rails helper methods and showcase
+their behavior. These helper methods called more complex Ruby classes to create a set of
+rich components, and we needed a way to showcase these components and their capabilites.
+I decided to create a more general application that could allow us to generate and organize
+any view templates that our Rails application knew how to process. Scrapbook is the result.
+Along the way, we discovered that not only was it a great place to document our components,
+but it was also great for doing the initial development as well.
+
+
+## Installation
+
+Add `scrapbook` to the `:development` group of your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'scrapbook'
+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.
+
+## Usage
+
+A scrapbook folder needs to contain a "pages" sub-folder. Any files and folders created in
+that "pages" folder will be exposed as part of the scrapbook unless their name begins with a
+period. These files and folders will show up as navigatable in Scrapbook's file browser, and
+if the file is a template file whose engine your main Rails application has installed, it
+will be properly processed to generate the HTML for you to view. These templates have access
+to all the helper methods defined in your main Rails application.
+
+When a folder is selected in Scrapbook's file browser, by default a small message appears in
+the main display area describing how to customize what is displayed when a folder is
+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
+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.
+
+## 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.
+
+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
+    ```
+
+
+## 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
+contribution guidelines](CONTRIBUTING.md).
+
+## Development Setup
+
+### Install TailwindCSS CLI
+
+If you need to submit updates to the theme or are using new Tailwind classes, you'll need to
+follow [the instructions to install the CLI](https://tailwindcss.com/docs/installation).
+After that you'll need to run the following commands to install the plugins:
+
+```
+$> npm install -D @tailwindcss/forms
+$> npm install -D @tailwindcss/aspect-ratio
+$> npm install -D @tailwindcss/typography
+```
+
+Once Tailwind's CLI has been installed, you can run it using the command below to update
+Scrapbook's CSS:
+
+```
+$> npx tailwindcss -i app/assets/stylesheets/scrapbook/application.tailwind.css -o app/assets/builds/scrapbook/tailwind.css --minify --watch
+```
+
+(Note, the "tailwindcss-rails" gem currently doesn't support Rails engines, so we have to
+install and run Tailwind manually.)
+
+## License
+
+Copyright 2022 Brad Lindsay
+
+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
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+[Discussion]: https://github.com/bfad/scrapbook/discussions

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/builds/scrapbook/tailwind.css

@@ -0,0 +1 @@
+/*! tailwindcss v3.0.23 | MIT License | https://tailwindcss.com*/*,:after,:before{box-sizing:border-box;border:0 solid #e5e7eb}:after,:before{--tw-content:""}html{line-height:1.5;-webkit-text-size-adjust:100%;-moz-tab-size:4;-o-tab-size:4;tab-size:4;font-family:ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji}body{margin:0;line-height:inherit}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}a{color:inherit;text-decoration:inherit}b,strong{font-weight:bolder}code,kbd,pre,samp{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:initial}sub{bottom:-.25em}sup{top:-.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:inherit;color:inherit;margin:0;padding:0}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button;background-color:initial;background-image:none}:-moz-focusring{outline:auto}:-moz-ui-invalid{box-shadow:none}progress{vertical-align:initial}::-webkit-inner-spin-button,::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}summary{display:list-item}blockquote,dd,dl,figure,h1,h2,h3,h4,h5,h6,hr,p,pre{margin:0}fieldset{margin:0}fieldset,legend{padding:0}menu,ol,ul{list-style:none;margin:0;padding:0}textarea{resize:vertical}input::-moz-placeholder,textarea::-moz-placeholder{opacity:1;color:#9ca3af}input:-ms-input-placeholder,textarea:-ms-input-placeholder{opacity:1;color:#9ca3af}input::placeholder,textarea::placeholder{opacity:1;color:#9ca3af}[role=button],button{cursor:pointer}:disabled{cursor:default}audio,canvas,embed,iframe,img,object,svg,video{display:block;vertical-align:middle}img,video{max-width:100%;height:auto}[hidden]{display:none}[multiple],[type=date],[type=datetime-local],[type=email],[type=month],[type=number],[type=password],[type=search],[type=tel],[type=text],[type=time],[type=url],[type=week],select,textarea{-webkit-appearance:none;-moz-appearance:none;appearance:none;background-color:#fff;border-color:#6b7280;border-width:1px;border-radius:0;padding:.5rem .75rem;font-size:1rem;line-height:1.5rem;--tw-shadow:0 0 #0000}[multiple]:focus,[type=date]:focus,[type=datetime-local]:focus,[type=email]:focus,[type=month]:focus,[type=number]:focus,[type=password]:focus,[type=search]:focus,[type=tel]:focus,[type=text]:focus,[type=time]:focus,[type=url]:focus,[type=week]:focus,select:focus,textarea:focus{outline:2px solid #0000;outline-offset:2px;--tw-ring-inset:var(--tw-empty,/*!*/ /*!*/);--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:#2563eb;--tw-ring-offset-shadow:var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);--tw-ring-shadow:var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color);box-shadow:var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow);border-color:#2563eb}input::-moz-placeholder,textarea::-moz-placeholder{color:#6b7280;opacity:1}input:-ms-input-placeholder,textarea:-ms-input-placeholder{color:#6b7280;opacity:1}input::placeholder,textarea::placeholder{color:#6b7280;opacity:1}::-webkit-datetime-edit-fields-wrapper{padding:0}::-webkit-date-and-time-value{min-height:1.5em}::-webkit-datetime-edit,::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-meridiem-field,::-webkit-datetime-edit-millisecond-field,::-webkit-datetime-edit-minute-field,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-second-field,::-webkit-datetime-edit-year-field{padding-top:0;padding-bottom:0}select{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3E%3Cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='m6 8 4 4 4-4'/%3E%3C/svg%3E");background-position:right .5rem center;background-repeat:no-repeat;background-size:1.5em 1.5em;padding-right:2.5rem;-webkit-print-color-adjust:exact;color-adjust:exact}[multiple]{background-image:none;background-position:0 0;background-repeat:unset;background-size:initial;padding-right:.75rem;-webkit-print-color-adjust:unset;color-adjust:unset}[type=checkbox],[type=radio]{-webkit-appearance:none;-moz-appearance:none;appearance:none;padding:0;-webkit-print-color-adjust:exact;color-adjust:exact;display:inline-block;vertical-align:middle;background-origin:border-box;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;flex-shrink:0;height:1rem;width:1rem;color:#2563eb;background-color:#fff;border-color:#6b7280;border-width:1px;--tw-shadow:0 0 #0000}[type=checkbox]{border-radius:0}[type=radio]{border-radius:100%}[type=checkbox]:focus,[type=radio]:focus{outline:2px solid #0000;outline-offset:2px;--tw-ring-inset:var(--tw-empty,/*!*/ /*!*/);--tw-ring-offset-width:2px;--tw-ring-offset-color:#fff;--tw-ring-color:#2563eb;--tw-ring-offset-shadow:var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);--tw-ring-shadow:var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color);box-shadow:var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}[type=checkbox]:checked,[type=radio]:checked{border-color:#0000;background-color:currentColor;background-size:100% 100%;background-position:50%;background-repeat:no-repeat}[type=checkbox]:checked{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 16 16' fill='%23fff' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12.207 4.793a1 1 0 0 1 0 1.414l-5 5a1 1 0 0 1-1.414 0l-2-2a1 1 0 0 1 1.414-1.414L6.5 9.086l4.293-4.293a1 1 0 0 1 1.414 0z'/%3E%3C/svg%3E")}[type=radio]:checked{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 16 16' fill='%23fff' xmlns='http://www.w3.org/2000/svg'%3E%3Ccircle cx='8' cy='8' r='3'/%3E%3C/svg%3E")}[type=checkbox]:checked:focus,[type=checkbox]:checked:hover,[type=checkbox]:indeterminate,[type=radio]:checked:focus,[type=radio]:checked:hover{border-color:#0000;background-color:currentColor}[type=checkbox]:indeterminate{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 16 16'%3E%3Cpath stroke='%23fff' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M4 8h8'/%3E%3C/svg%3E");background-size:100% 100%;background-position:50%;background-repeat:no-repeat}[type=checkbox]:indeterminate:focus,[type=checkbox]:indeterminate:hover{border-color:#0000;background-color:currentColor}[type=file]{background:unset;border-color:inherit;border-width:0;border-radius:0;padding:0;font-size:unset;line-height:inherit}[type=file]:focus{outline:1px auto -webkit-focus-ring-color}body>nav li{cursor:default}body>nav a,body>nav a:active,body>nav a:hover,body>nav a:visited{color:#0f172a;cursor:default;text-decoration:none;transition:background-color 80ms linear;font-weight:400;font-size:unset;line-height:inherit}body>nav a:hover{background-color:#f0f9ff}body>nav a:active{background-color:#bae6fd}*,:after,:before{--tw-translate-x:0;--tw-translate-y:0;--tw-rotate:0;--tw-skew-x:0;--tw-skew-y:0;--tw-scale-x:1;--tw-scale-y:1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness:proximity;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-color:#3b82f680;--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000;--tw-shadow-colored:0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: }.block{display:block}.flex{display:flex}.contents{display:contents}.h-screen{height:100vh}.h-full{height:100%}.w-screen{width:100vw}.w-full{width:100%}.min-w-\[20ch\]{min-width:20ch}.max-w-\[50\%\]{max-width:50%}.flex-none{flex:none}.overflow-scroll{overflow:scroll}.border-0{border-width:0}.border-r{border-right-width:1px}.border-solid{border-style:solid}.border-sky-700{--tw-border-opacity:1;border-color:rgb(3 105 161/var(--tw-border-opacity))}.bg-sky-100{--tw-bg-opacity:1;background-color:rgb(224 242 254/var(--tw-bg-opacity))}.\!px-0{padding-left:0!important;padding-right:0!important}.py-2{padding-top:.5rem;padding-bottom:.5rem}.px-4{padding-left:1rem;padding-right:1rem}.text-2xl{font-size:1.5rem;line-height:2rem}.children\:px-4>*{padding-left:1rem;padding-right:1rem}

data/app/assets/config/scrapbook_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/scrapbook .css

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

@@ -0,0 +1,15 @@
+/*
+ * 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/assets/stylesheets/scrapbook/application.tailwind.css

@@ -0,0 +1,32 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+@layer base {
+  /* Not sure base is correct here */
+  body > nav li {
+    cursor: default;
+  }
+
+  body > nav a,
+  body > nav a:hover,
+  body > nav a:active,
+  body > nav a:visited
+  {
+    color: theme('colors.slate.900');
+    cursor:  default;
+    text-decoration: none;
+    transition: background-color 80ms linear;
+    font-weight: normal;
+    font-size: unset;
+    line-height:inherit;
+  }
+
+  body > nav a:hover {
+    background-color: theme('colors.sky.50');
+  }
+
+  body > nav a:active {
+    background-color: theme('colors.sky.200');
+  }
+}

data/app/controllers/scrapbook/application_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  # @private
+  #
+  # Base controller for collecting shared functionality for the Scaapbook App.
+  # placeholder
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/scrapbook/empty_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  # This controller is used to specify view paths to check if a template exists.
+  class EmptyController < ApplicationController
+    self.view_paths = []
+  end
+  private_constant :EmptyController
+end

data/app/controllers/scrapbook/pages_controller.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  # @todo Document this controller
+  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')
+
+      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
+    end
+
+    def raw
+      return head(:not_found) if (scrapbook = find_scrapbook).nil?
+
+      pathname = calculate_pathname(scrapbook, params[:id])
+      template = params[:id].delete_suffix('.html')
+
+      if scrapbook_template_exists?(scrapbook, template)
+        prepend_view_path(scrapbook.pages_pathname)
+        render template: template,
+          locals: {scrapbook: scrapbook, pathname: pathname},
+          layout: 'layouts/scrapbook/host_application'
+      elsif pathname.exist?
+        render file: pathname
+      else
+        head :not_found
+      end
+    end
+
+    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
+
+      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
+    end
+
+    def scrapbook_template_exists?(scrapbook, template)
+      EmptyController.new.tap { |c| c.prepend_view_path(scrapbook.pages_pathname) }.template_exists?(template)
+    end
+  end
+end

data/app/helpers/scrapbook/application_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  # Engine-wide helpers
+  module ApplicationHelper
+    # Using `include Rails.application.helpers` didn't work for reloading changes
+    # made to the main app's helper methods, but this is adapted from its code.
+    # (I think it's getting around the memoized "@helpers" variable.)
+    # https://github.com/rails/rails/blob/6bfc637659248df5d6719a86d2981b52662d9b50/railties/lib/rails/engine.rb#L494
+    ActionController::Base.modules_for_helpers(
+      ActionController::Base.all_helpers_from_path(Rails.application.helpers_paths)
+    ).each { include _1 }
+  end
+end

data/app/helpers/scrapbook/folder_listing_view_model.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  # Model to assest list a folder's contents
+  class FolderListingViewModel
+    attr_reader :view, :scrapbook, :pathname, :files, :folders
+
+    def initialize(view, scrapbook, pathname)
+      self.view = view
+      self.scrapbook = scrapbook
+      self.pathname = pathname.directory? ? pathname : pathname.dirname
+      self.folders, self.files = split_files_and_folders
+    end
+
+    def root?
+      pathname == scrapbook.pages_pathname
+    end
+
+    def parent_display_name
+      return nil if root?
+      return scrapbook.name if pathname.parent == scrapbook.pages_pathname
+
+      pathname.parent.basename.to_s
+    end
+
+    def header_name
+      root? ? "/#{scrapbook.name}" : "/#{pathname.basename}/"
+    end
+
+    private
+
+    attr_writer :view, :scrapbook, :pathname, :files, :folders
+
+    def split_files_and_folders
+      helper = HelperForView.new(view)
+
+      folders, files = pathname.children.each_with_object([[], []]) do |pname, acc|
+        next if pname.basename.to_s.start_with?('.')
+
+        if pname.directory?
+          acc[0] << pname
+        else
+          acc[1] << helper.remove_handler_exts_from(pname)
+        end
+      end
+
+      folders.sort! { |a, b| a.to_s.downcase <=> b.to_s.downcase }
+      files.sort! { |a, b| a.to_s.downcase <=> b.to_s.downcase }
+
+      [folders, files]
+    end
+  end
+end

data/app/helpers/scrapbook/helper_for_view.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  # View helpers for the Scrapbook gem. Doesn't use standard Rail's helper
+  # modules to avoid any conflicts with host app
+  class HelperForView
+    def initialize(view)
+      self.view = view
+    end
+
+    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, '/')
+    end
+
+    def remove_handler_exts_from(pathname)
+      pathname.dirname.join(
+        pathname.basename.sub(/(?:.#{view.lookup_context.handlers.join('|.')})+\z/, '')
+      )
+    end
+
+    private
+
+    attr_accessor :view
+  end
+end

data/app/mailers/scrapbook/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/scrapbook/scrapbook.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  # Modeling the scrap book
+  class Scrapbook
+    NotFoundError = Class.new(StandardError)
+
+    attr_accessor :root
+
+    def self.find_scrapbook_for(pathname)
+      scrapbooks = ::Scrapbook::Engine.config.scrapbook.paths
+      candidates = scrapbooks.each_with_index.filter_map do |pname, index|
+        relative_path = pathname.relative_path_from(pname)
+        next if relative_path.to_s.start_with?('..')
+
+        [index, relative_path.each_filename.count]
+      end
+      raise NotFoundError if candidates.empty?
+
+      new(scrapbooks[candidates.min_by { _1[1] }.first])
+    end
+
+    def initialize(root)
+      self.root = Pathname.new(root)
+    end
+
+    def name
+      root.basename
+    end
+
+    def pages_pathname
+      root.join('pages')
+    end
+
+    def relative_page_path_for(pathname)
+      return '' if pathname == pages_pathname
+
+      relative_path = pathname.relative_path_from(pages_pathname).to_s
+      if relative_path.start_with?('..')
+        raise ArgumentError, "Pathname isn't inside the scrapbook pages: #{relative_path}"
+      end
+
+      relative_path
+    end
+
+    def ==(other)
+      other.class == self.class && other.root == root
+    end
+    alias eql? ==
+  end
+end

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

@@ -0,0 +1,9 @@
+<%
+  helper = Scrapbook::HelperForView.new(self)
+  listing = Scrapbook::FolderListingViewModel.new(self, scrapbook, pathname)
+  pathname_without_handler_exts = helper.remove_handler_exts_from(pathname)
+%>
+<% unless listing.root? %><%= link_to "‹ #{listing.parent_display_name}", helper.short_path_to(listing.pathname.parent), class: 'back-to-parent block w-100' %><% end %>
+<header aria-label="Which folder's contents" class="text-2xl <%= listing.pathname == pathname ? 'bg-sky-100' : '!px-0 children:px-4' %>"><% if listing.pathname == pathname %><span aria-current="page"><%= listing.header_name %></span><% else %><%= link_to(listing.header_name, helper.short_path_to(listing.pathname), class: 'block w-100') %><% end %></header>
+<ul class="!px-0" aria-label="Sub-folders"><% listing.folders.each do |folder| %><li class="children:px-4"><%= link_to "#{folder.basename}/", helper.short_path_to(folder, scrapbook), class: 'block w-100' %></li><% end %></ul>
+<ul class="!px-0" aria-label="Sub-files"><% listing.files.each do |file| %><% next if listing.folders.include?(file) %><li class="children:px-4"><% if file == pathname_without_handler_exts %><span class="block w-100 bg-sky-100" aria-current="page"><%= file.basename %></span><% else %><%= link_to file.basename, helper.short_path_to(file, scrapbook), class: 'block w-100' %><% end %></li><% end %></ul>

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <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" %>
+</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>
+  <main class="py-2 px-4 h-screen w-screen overflow-scroll"><%= yield %></main>
+</body>
+</html>

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

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= yield(:head) %>
+</head>
+<body>
+  <main><%= yield %></main>
+</body>
+</html>

data/app/views/pages.html.erb

@@ -0,0 +1 @@
+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.

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

@@ -0,0 +1 @@
+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.

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

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

data/config/routes.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+Scrapbook::Engine.routes.draw do
+  book_regex = /#{Scrapbook::Engine.config.scrapbook.paths.map { File.basename(_1) }.join('|')}/
+
+  resources :pages, id: /.+/
+  resources :pages, path: ':book/pages', id: /.+/, constraints: {book: book_regex}
+
+  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 '*id', to: 'pages#show', constraints: {id: /.*/}, as: :short_page
+end

data/lib/generators/scrapbook/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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')
+      generate 'scrapbook:new', options.fetch('path-with-name')
+    end
+  end
+end

data/lib/generators/scrapbook/new_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+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.
+  class NewGenerator < Rails::Generators::Base
+    argument :name, optional: true, default: 'scrapbook'
+
+    def new
+      create_file("#{name}/pages/.keep")
+
+      # TODO: Investigate using hooks to default to ERB, but allow templates to overwrite
+      create_file("#{name}/pages.html.erb",
+        <<~HTML
+          <h1>Welcome to Scrapbook</h1>
+          <p>Feel free to customize this page and add more folders and pages to your Scrapbook</p>
+        HTML
+      )
+    end
+  end
+end

data/lib/generators/scrapbook/routes_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+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.
+  class RoutesGenerator < Rails::Generators::Base
+    argument :path, 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
+    end
+  end
+end

data/lib/scrapbook/engine.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Scrapbook
+  # :nodoc:
+  class Engine < ::Rails::Engine
+    isolate_namespace Scrapbook
+
+    config.scrapbook = ActiveSupport::OrderedOptions.new
+    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
+        ]
+      end
+    end
+  end
+end

data/lib/scrapbook/version.rb

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

data/lib/scrapbook.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'scrapbook/version'
+require 'scrapbook/engine'
+
+# TODO: Figure out documentation
+# Placeholder
+module Scrapbook
+  # Your code goes here...
+end

data/lib/tasks/scrapbook_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :scrapbook do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: scrapbook
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Brad Lindsay
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: Scrapbook allows you to collect and document complex view helpers or
+  partials.
+email:
+- sluggy.fan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/builds/scrapbook/tailwind.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
+- app/controllers/scrapbook/pages_controller.rb
+- app/helpers/scrapbook/application_helper.rb
+- app/helpers/scrapbook/folder_listing_view_model.rb
+- app/helpers/scrapbook/helper_for_view.rb
+- app/mailers/scrapbook/application_mailer.rb
+- app/models/scrapbook/scrapbook.rb
+- app/views/layouts/scrapbook/_folder_listing.html.erb
+- 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
+- lib/generators/scrapbook/new_generator.rb
+- lib/generators/scrapbook/routes_generator.rb
+- lib/scrapbook.rb
+- lib/scrapbook/engine.rb
+- lib/scrapbook/version.rb
+- lib/tasks/scrapbook_tasks.rake
+homepage: https://bfad.github.io/scrapbook
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://bfad.github.io/scrapbook
+  source_code_uri: https://github.com/bfad/scrapbook
+  changelog_uri: https://github.com/bfad/scrapbook/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.4
+signing_key:
+specification_version: 4
+summary: A place to document and test view helpers for Ruby on Rails
+test_files: []