templates-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb94bce07ae247f36c8b9a45332b562158fb7cc51e909c9d3d7737d3e7e30201
+  data.tar.gz: 98b3fe59cc0022810e87a0aa5b3485d8522ea99c03f9f26133982b5b471e4bab
+SHA512:
+  metadata.gz: 26e76e6bd2031e4856534a23977d32c8dd674266ee371c9623e498e171b467b90c40c814f19ca337564702124c395efac8b40738126f1346426b40bf315d47a9
+  data.tar.gz: f075cdff765cd1b22e80866bded4e9921662d7f773f31428d75e72e192ddf71f20316286f6f237a9279121c192493d8fd8a93ba795e01c07720e0421f915be7f

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ancez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Templates
+[![Gem Version](http://img.shields.io/gem/v/templates-rails.svg)](https://github.com/Ancez/templates-rails/blob/master/CHANGELOG.md)
+[![Rspec](https://github.com/Ancez/templates-rails/actions/workflows/rspec.yml/badge.svg)](https://github.com/Ancez/templates-rails/actions/workflows/rspec.yml)
+[![Ruby Gem](https://github.com/Ancez/templates-rails/actions/workflows/gem-push.yml/badge.svg)](https://rubygems.org/gems/templates-rails)
+
+Simple to use templating system for your Rails application. Design your views before implementation.
+
+Dummy can be viewed [here](https://templates-rails.herokuapp.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'templates-rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install templates-rails
+
+Run
+
+    $ rake templates:install
+- This will add the templates engine to your routes by adding:
+  - `mount Templates::Engine => '/'`
+- And will automatically generate `views/templates/example` directory and an example `.html.erb` file `/views/templates/example.html.erb`
+- It will also generate empty `partials` directories to showcase that you can still partialise your design views with a structure
+- `partials` directories are excluded from being shown within the indexes
+
+## Usage
+
+The rake task mentioned above generates examples for you to edit, delete and/or copy from.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ancez/templates-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Ancez/templates-rails/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the templates-rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/templating/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/templates_manifest.js

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

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

@@ -0,0 +1,73 @@
+/*
+ * 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
+ */
+
+.templates {
+  display: flex;
+  flex-direction: column;
+  margin: 0;
+}
+
+.templates a {
+  background-color: #ffffff;
+  border-radius: 5px;
+  border: 1px solid #3D7EB8;
+  box-shadow: 0 1px 2px 0 rgb(0 0 0 / 0.05);
+  color: #3D7EB8;
+  display: block;
+  margin: 12px;
+  padding: 8px 12px;
+  text-decoration: none;
+  transition: color, background-color 300ms ease;
+}
+
+.templates a:hover {
+  background-color: #3D7EB8;
+  color: #ffffff;
+}
+
+.templates__header {
+  background-color: #5893C7;
+  border-bottom: 1px solid #3D7EB8;
+  color: #ffffff;
+  display: flex;
+  justify-content: center;
+}
+
+.templates__header div {
+  align-items: center;
+  display: flex;
+  justify-content: space-between;
+  max-width: 1440px;
+  min-height: 60px;
+  width: 100%;
+}
+
+.templates__header div h1 {
+  margin: 6px 0;
+  padding: 0 24px;
+}
+
+.templates__content {
+  display: flex;
+  justify-content: center;
+}
+
+.templates__content div {
+  display: flex;
+  flex-wrap: wrap;
+  max-width: 1440px;
+  width: 100%;
+}

data/app/controllers/templates/templates_controller.rb

@@ -0,0 +1,13 @@
+class Templates::TemplatesController < ApplicationController
+  def index
+    render :index, layout: 'templates/index'
+  end
+
+  def show
+    if params[:id].present? && File.directory?("./app/views/templates/#{params[:id]}")
+      render :nested_index, layout: 'templates/index'
+    else
+      render "templates/#{params[:id]}", layout: 'templates/show'
+    end
+  end
+end

data/app/views/layouts/templates/index.html.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= yield(:title) if content_for?(:title) %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+
+    <%= stylesheet_link_tag 'templates/application', media: 'all' %>
+  </head>
+
+  <body class="templates">
+    <div class="templates__header">
+      <div>
+        <h1><%= yield(:title) if content_for?(:title) %></h1>
+        <%= link_to 'Go Back', templates_path if params[:id].present? %>
+      </div>
+    </div>
+
+    <div class="templates__content">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/app/views/layouts/templates/show.html.erb

@@ -0,0 +1 @@
+<%= render template: yield(:layout_override).present? ? "/layouts/#{yield(:layout_override)}" : 'layouts/application' %>

data/app/views/templates/templates/index.html.erb

@@ -0,0 +1,7 @@
+<% provide(:title, 'Templates') %>
+
+<div>
+  <% Dir.children('./app/views/templates').excluding('partials').sort.each do |child| %>
+    <%= link_to child.chomp('.html.erb').humanize.titleize, template_path(child.chomp('.html.erb')), class: 'button button--blue' %>
+  <% end %>
+</div>

data/app/views/templates/templates/nested_index.html.erb

@@ -0,0 +1,7 @@
+<% provide(:title, params[:id].gsub('/', ' / ').titleize) %>
+
+<div>
+  <% Dir.children("./app/views/templates/#{params[:id]}").excluding('partials').sort.each do |child| %>
+    <%= link_to child.chomp('.html.erb').humanize.titleize, template_path("#{params[:id]}/#{child.chomp('.html.erb')}"), class: 'button button--blue' %>
+  <% end %>
+</div>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Templates::Engine.routes.draw do
+  root 'templates#index'
+  resources :templates, only: [:index, :show]
+end

data/lib/install/templates.rb

@@ -0,0 +1,10 @@
+say 'Mounting Engine'
+insert_into_file(
+  'config/routes.rb',
+  %(mount Templates::Engine => '/' if Rails.env.development?),
+  before: /\s*end/
+)
+append_to_file 'config/routes.rb', %(mount Templates::Engine => '/' if Rails.env.development?\n), before: "\nend"
+
+say 'Creating Templates Directory'
+file_create 'app/views/templates/example.html.erb', "<%= provide(:title, 'Example') %>\nExample"

data/lib/tasks/templates_tasks.rake

@@ -0,0 +1,13 @@
+def run_templates_install_template(path) system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/#{path}.rb",  __dir__)}" end
+
+namespace :templates do
+  desc 'Install Templates'
+  task :install do
+    if Rails.root.join('config/routes.rb').exist?
+      run_templates_install_template 'templates'
+    else
+      puts 'config/routes.rb file found'
+    end
+  end
+end
+

data/lib/templates/engine.rb

@@ -0,0 +1,9 @@
+module Templates
+  class Engine < ::Rails::Engine
+    isolate_namespace Templates
+
+    initializer 'templates.assets.precompile' do |app|
+      app.config.assets.precompile += %w( application.css )
+    end
+  end
+end

data/lib/templates/version.rb

@@ -0,0 +1,3 @@
+module Templates
+  VERSION = '0.1.0'
+end

data/lib/templates-rails.rb

@@ -0,0 +1,6 @@
+require 'templates/version'
+require 'templates/engine'
+
+module Templates
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: templates-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lukasz Czapiewski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A templating system for creating and making design decisions for your
+  Rails application. Make your design decisions before you build your application
+  views.
+email:
+- luke@mmtm.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/config/templates_manifest.js
+- app/assets/stylesheets/templates/application.css
+- app/controllers/templates/templates_controller.rb
+- app/views/layouts/templates/index.html.erb
+- app/views/layouts/templates/show.html.erb
+- app/views/templates/templates/index.html.erb
+- app/views/templates/templates/nested_index.html.erb
+- config/routes.rb
+- lib/install/templates.rb
+- lib/tasks/templates_tasks.rake
+- lib/templates-rails.rb
+- lib/templates/engine.rb
+- lib/templates/version.rb
+homepage: https://github.com/Ancez/templates-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Ancez/templates-rails
+  source_code_uri: https://github.com/Ancez/templates-rails
+  changelog_uri: https://github.com/Ancez/templates-rails/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Simple to use templating system for your Rails application. Design your views
+  before implementation.
+test_files: []