mozaic 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35980466fff36ddb7ab0a0454f497cdde5d9665abfaf2447d427376173134fd2
+  data.tar.gz: f9260f944122932705d9767deb77119cb92342cc650b23082cbc73eeda26577a
+SHA512:
+  metadata.gz: 273f13503afde1563c9552ea1f0be5b4546f22f89457cc02df25d85a4b578be6e6c651f35074f0689c95230c4faaa5b38cab9312937136202247923dc82bc9f0
+  data.tar.gz: 337c765c07700f0b43864878bf6d21289373c9e2a16284e59625ee49b432f8c9b652f1f26134edef524cbda8a2ae28d03e0da980c7da2d19612ad03d2c073347

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2018/01/10
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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,210 @@
+# Mozaic
+
+[![Gem Version](https://badge.fury.io/rb/mozaic.svg)](https://badge.fury.io/rb/mozaic) <img src="https://travis-ci.org/jonhue/mozaic.svg?branch=master" />
+
+Mozaic is an opinionated layout engine for Rails. It simplifies handling numerous layouts and components.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Layouts](#layouts)
+    * [Components](#components)
+* [Configuration](#configuration)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+Mozaic works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'mozaic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mozaic
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'mozaic', github: 'jonhue/mozaic'
+```
+
+Now run the generator:
+
+    $ rails g mozaic:install
+
+---
+
+## Usage
+
+### Layouts
+
+You can run a generator to create new layouts
+
+    $ rails g mozaic:layout -n my/new/layout
+
+**Note:** Pass the `-e` option to extend another layout with this new layout.
+
+You can use the `mozaic` helper to extend other layouts:
+
+```haml
+= mozaic :layout do
+    ...
+```
+
+`mozaic` takes the layout you want to extend as a first and the area where content should be rendered as a second parameter. Both of them default to `:mozaic`.
+
+Here is how you specify areas to extend layouts:
+
+```haml
+= mozaic_area :area do
+    ...
+```
+
+**Note:** Make sure that your area names are unique across all layouts.
+
+### Components
+
+Mozaic allows you to define components to organize your code:
+
+    $ rails g mozaic:component -n name
+
+```ruby
+Mozaic.configure do |config|
+    config.define_component :name
+end
+```
+
+You are also able to pass default options to your components:
+
+```ruby
+Mozaic.configure do |config|
+    config.define_component :name, lovely: true
+end
+```
+
+```haml
+= options[:lovely].to_s
+```
+
+You can run custom code whenever your component gets rendered:
+
+```ruby
+Mozaic.configure do |config|
+    config.define_component :name, lovely: true do
+        options[:lovely] = !options[:lovely]
+    end
+end
+```
+
+Components can also be defined in your ActiveRecord classes:
+
+```ruby
+class User < ApplicationRecord
+    define_component :avatar
+end
+```
+
+Rendering components is fairly straight forward:
+
+```haml
+= component :name
+```
+
+You are able to override the default options:
+
+```haml
+= component :name, lovely: false
+```
+
+And to pass a block:
+
+```haml
+= component :name, lovely: false do
+    It is lovely.
+```
+
+Here is how to access a block in your component:
+
+```haml
+= options[:lovely].to_s
+= block
+```
+
+---
+
+## Configuration
+
+You can configure Mozaic by passing a block to `configure`. This can be done in `config/initializers/mozaic.rb`:
+
+```ruby
+Mozaic.configure do |config|
+    config.define_component :name
+end
+```
+
+* `define_component` Define components
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/mozaic/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/mozaic/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to Mozaic. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/jonhue/mozaic/graphs/contributors
+
+### Semantic Versioning
+
+Mozaic follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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/app/helpers/mozaic/component_helper.rb

@@ -0,0 +1,17 @@
+module Mozaic
+    module ComponentHelper
+
+        def component name, options = {}, &block
+            component = Mozaic::Component.find_by_name(name.to_sym).first
+            component.render options
+            render partial: "mozaic/#{name.to_s}", locals: { options: component.options(options), block: ( block_given? ? capture(&block) : nil ) }
+        end
+
+        def component_wrapper name, options = {}, &block
+            content_tag class: "#{name.to_s.split('/').join(' ')} #{options[:class]}", id: options[:id] do
+                capture(&block)
+            end
+        end
+
+    end
+end

data/app/helpers/mozaic/layout_helper.rb

@@ -0,0 +1,23 @@
+module Mozaic
+    module LayoutHelper
+
+        def mozaic parent = :mozaic, area = :mozaic, &block
+            extends parent.to_sym do
+                replace area.to_sym do
+                    capture(&block)
+                end
+            end
+        end
+
+        def mozaic_area name = :mozaic, &block
+            if block_given?
+                area name.to_sym do
+                    capture(&block)
+                end
+            else
+                area name.to_sym
+            end
+        end
+
+    end
+end

data/lib/generators/mozaic/component_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Mozaic
+    class ComponentGenerator < Rails::Generators::Base
+
+        include Rails::Generators::Migration
+
+        source_root File.join File.dirname(__FILE__), '../templates/component'
+        desc 'Generate a Mozaic component'
+
+        class_option :name, desc: 'Component name', type: :string, aliases: '-n'
+
+        def create_files
+            names = options[:name].split('/')
+            name = names.pop
+            template 'partial.html.erb', "app/views/mozaic/#{names.join('/')}/_#{name}.html.erb"
+        end
+
+    end
+end

data/lib/generators/mozaic/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Mozaic
+    class InstallGenerator < Rails::Generators::Base
+
+        include Rails::Generators::Migration
+
+        source_root File.join File.dirname(__FILE__), '../templates/install'
+        desc 'Install Mozaic'
+
+        def create_initializer
+            template 'initializer.rb', 'config/initializers/mozaic.rb'
+        end
+
+        def create_layout
+            template 'layout.html.erb', 'app/views/layouts/mozaic.html.erb'
+        end
+
+    end
+end

data/lib/generators/mozaic/layout_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Mozaic
+    class LayoutGenerator < Rails::Generators::Base
+
+        include Rails::Generators::Migration
+
+        source_root File.join File.dirname(__FILE__), '../templates/layout'
+        desc 'Generate a Mozaic layout'
+
+        class_option :name, desc: 'Layout name', type: :string, aliases: '-n'
+        class_option :extends, desc: 'Layout this layout is extending', type: :string, aliases: '-e'
+
+        def create_files
+            names = options[:name].split('/')
+            name = names.pop
+            template 'layout.html.erb', "app/views/layouts/#{names.join('/')}/#{name].html.erb}"
+        end
+
+    end
+end

data/lib/generators/templates/component/partial.html.erb

@@ -0,0 +1,2 @@
+<%%= component_wrapper '<%= options[:name] %>' do %>
+<%% end %>

data/lib/generators/templates/install/initializer.rb

@@ -0,0 +1,6 @@
+Mozaic.configure do |config|
+
+    # Define Mozaic components
+    # config.define_component :name
+
+end

data/lib/generators/templates/install/layout.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title></title>
+        <%%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': true %>
+        <%%= javascript_include_tag 'application', 'data-turbolinks-track': true %>
+        <%%= csrf_meta_tags %>
+    </head>
+    <body>
+        <%%= mozaic_area do %>
+            <%%= yield %>
+        <%% end %>
+    </body>
+</html>

data/lib/generators/templates/layout/layout.html.erb

@@ -0,0 +1,2 @@
+<%%= mozaic<%= " '#{options[:extends]}'" if options.has_key?(:extends) %> do %>
+<%% end %>

data/lib/mozaic.rb

@@ -0,0 +1,13 @@
+require 'mozaic/version'
+
+module Mozaic
+
+    require 'mozaic/configuration'
+
+    require 'mozaic/component'
+    require 'mozaic/component/define'
+
+    require 'mozaic/engine'
+    require 'mozaic/railtie'
+
+end

data/lib/mozaic/component.rb

@@ -0,0 +1,32 @@
+module Mozaic
+    class Component
+
+        cattr_accessor :instances
+        attr_accessor :name
+        attr_accessor :block
+        attr_writer :options
+
+        def initialize name, options = {}, &block
+            self.name = name.to_sym
+            self.block = block if block_given?
+            self.options = options
+            self.class.instances = [] if @@instances.nil?
+            self.class.instances << self
+        end
+
+        def options options = {}
+            @options.merge! options
+        end
+
+        def render options = {}
+            self.options = self.options options
+            self.block.call unless self.block.nil?
+        end
+
+        def self.find_by_name name
+            return [] if self.instances.nil?
+            self.instances.select { |component| component.name == name.to_sym }
+        end
+
+    end
+end

data/lib/mozaic/component/define.rb

@@ -0,0 +1,17 @@
+module Mozaic
+    class Component
+        module Define
+
+            def define_component name, options = {}
+                Mozaic.configure do |config|
+                    if block_given?
+                        config.define_component name.to_sym, options, &Proc.new
+                    else
+                        config.define_component name.to_sym, options
+                    end
+                end
+            end
+
+        end
+    end
+end

data/lib/mozaic/configuration.rb

@@ -0,0 +1,23 @@
+module Mozaic
+
+    class << self
+        attr_accessor :configuration
+    end
+
+    def self.configure
+        self.configuration ||= Configuration.new
+        yield configuration
+    end
+
+    class Configuration
+
+        def define_component name, options = {}
+            if block_given?
+                Mozaic::Component.new name.to_sym, options, &Proc.new
+            else
+                Mozaic::Component.new name.to_sym, options
+            end
+        end
+
+    end
+end

data/lib/mozaic/engine.rb

@@ -0,0 +1,6 @@
+require 'rails/railtie'
+
+module Mozaic
+    class Engine < ::Rails::Engine
+    end
+end

data/lib/mozaic/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails/railtie'
+require 'active_support'
+
+module Mozaic
+    class Railtie < Rails::Railtie
+
+        initializer 'mozaic.initialize' do
+            ActiveSupport.on_load :active_record do
+                include Mozaic::Component::Define
+            end
+        end
+
+    end
+end

data/lib/mozaic/version.rb

@@ -0,0 +1,5 @@
+module Mozaic
+
+    VERSION = '1.0.0'
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: mozaic
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: nestive-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Mozaic is an opinionated layout engine for Rails. It simplifies handling
+  numerous layouts and components.
+email: me@jonhue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/helpers/mozaic/component_helper.rb
+- app/helpers/mozaic/layout_helper.rb
+- lib/generators/mozaic/component_generator.rb
+- lib/generators/mozaic/install_generator.rb
+- lib/generators/mozaic/layout_generator.rb
+- lib/generators/templates/component/partial.html.erb
+- lib/generators/templates/install/initializer.rb
+- lib/generators/templates/install/layout.html.erb
+- lib/generators/templates/layout/layout.html.erb
+- lib/mozaic.rb
+- lib/mozaic/component.rb
+- lib/mozaic/component/define.rb
+- lib/mozaic/configuration.rb
+- lib/mozaic/engine.rb
+- lib/mozaic/railtie.rb
+- lib/mozaic/version.rb
+homepage: https://github.com/jonhue/mozaic
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Mozaic is an opinionated layout engine for Rails
+test_files: []