cadmus_navbar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cc884819b26230638f378ae03eba08ed8a4cf794a36fa81e094ba8535805c63
+  data.tar.gz: 0d46a6f7d19be6c76dcb6632186c61e55e895c6f8f7143fe5a92f6ffa626ed81
+SHA512:
+  metadata.gz: 35a046e871a02099ebf915b884c88703118a2e6677c465a875531fdae9a3ccdde73bacbcf53e75b7abf06252558b7eb56379573478893cd48526b67fdc2d3b77
+  data.tar.gz: 449b864d6f7229e4a424610af1f6a8713961643ef3897a113e6b0167ff97e1df5ca6f42c8bbd32743ae9819e93b8ff66a35c9fcab96f355b067437b3c351ccde

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cadmus_navbar.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# CadmusNavbar
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cadmus_navbar`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cadmus_navbar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cadmus_navbar
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/[USERNAME]/cadmus_navbar.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/app/views/cadmus/navigation_items/index.html.erb

@@ -0,0 +1,3 @@
+<h1 class="mb-4">Navigation bar</h1>
+
+<div data-react-class="CadmusNavbarAdminApp" data-react-props="<%={ baseUrl: url_for(action: 'index'), pagesUrl: url_for(controller: 'pages', action: 'index') }.to_json%>"></div>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cadmus_navbar"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cadmus_navbar.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cadmus_navbar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cadmus_navbar"
+  spec.version       = CadmusNavbar::VERSION
+  spec.authors       = ["Nat Budin"]
+  spec.email         = ["natbudin@gmail.com"]
+
+  spec.summary       = %q{Adminable navigation bars for Cadmus sites}
+  spec.description   = %q{Adds models and renderers for navigation bars to the Cadmus micro-CMS}
+  spec.homepage      = "https://github.com/nbudin/cadmus_navbar"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 5.0.0"
+  spec.add_dependency "cadmus"
+  spec.add_dependency "acts_as_list"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/cadmus_navbar.rb

@@ -0,0 +1,17 @@
+require 'acts_as_list'
+
+require "cadmus_navbar/version"
+
+require "cadmus"
+require "cadmus_navbar/engine"
+
+module CadmusNavbar
+  extend Cadmus::Concerns::OtherClassAccessor
+  other_class_accessor :navigation_item_model
+
+  extend ActiveSupport::Autoload
+  autoload :AdminController
+  autoload :NavigationItem
+  autoload :Renderer
+  autoload :Renderers
+end

data/lib/cadmus_navbar/admin_controller.rb

@@ -0,0 +1,73 @@
+module CadmusNavbar
+  module AdminController
+    extend ActiveSupport::Concern
+    include Cadmus::Concerns::ControllerWithParent
+
+    included do
+      before_action :load_parent_and_navigation_item
+    end
+
+    def index
+      respond_to do |format|
+        format.html { render template: 'cadmus/navigation_items/index' }
+        format.json do
+          render json: {
+            navigation_items: navigation_item_scope,
+            csrf_token: (protect_against_forgery? ? form_authenticity_token: nil)
+          }
+        end
+      end
+    end
+
+    def create
+      @navigation_item = navigation_item_scope.new(navigation_item_params)
+
+      if @navigation_item.save
+        render json: { navigation_item: @navigation_item }, status: :created
+      else
+        render json: { errors: @navigation_item.errors }, status: :not_acceptable
+      end
+    end
+
+    def update
+      if @navigation_item.update_attributes(navigation_item_params)
+        render json: { navigation_item: @navigation_item }, status: :accepted
+      else
+        render json: { errors: @navigation_item.errors }, status: :not_acceptable
+      end
+    end
+
+    def destroy
+      @navigation_item.destroy
+      head :ok
+    end
+
+    def sort
+      navigation_item_sort_params.each do |item_params|
+        navigation_item_scope.where(id: item_params[:id]).update_all(item_params.to_h.except(:id))
+      end
+
+      head :ok
+    end
+
+    protected
+
+    def navigation_item_scope
+      @navigation_item_scope ||= parent_model ? parent_model.navigation_items : CadmusNavbar.navigation_item_model.global
+    end
+
+    def navigation_item_params
+      params.require(:navigation_item).permit(:parent_id, :title, :page_id, :navigation_section_id)
+    end
+
+    def navigation_item_sort_params
+      params.require(:navigation_items).map { |item_params| item_params.permit(:id, :position, :navigation_section_id) }
+    end
+
+    def load_parent_and_navigation_item
+      if params[:id]
+        @navigation_item = navigation_item_scope.find(params[:id])
+      end
+    end
+  end
+end

data/lib/cadmus_navbar/engine.rb

@@ -0,0 +1,7 @@
+module CadmusNavbar
+  class Engine < Rails::Engine
+    config.to_prepare do
+      CadmusNavbar.clear_navigation_item_model_cache!
+    end
+  end
+end

data/lib/cadmus_navbar/navigation_item.rb

@@ -0,0 +1,28 @@
+module CadmusNavbar
+  module NavigationItem
+    extend ActiveSupport::Concern
+    include Cadmus::Concerns::ModelWithParent
+
+    module ClassMethods
+      def cadmus_navigation_item
+        model_with_parent
+
+        belongs_to :navigation_section, class_name: self.name, inverse_of: :navigation_links, optional: true
+        belongs_to :page, class_name: Cadmus.page_model.name, optional: true
+        has_many :navigation_links, class_name: self.name, foreign_key: 'navigation_section_id', inverse_of: :navigation_section, dependent: :destroy
+
+        scope :root, -> { where(navigation_section_id: nil) }
+
+        acts_as_list scope: [:parent_type, :parent_id, :navigation_section_id]
+      end
+    end
+
+    def item_type
+      if page || navigation_section
+        'link'
+      else
+        'section'
+      end
+    end
+  end
+end

data/lib/cadmus_navbar/renderer.rb

@@ -0,0 +1,64 @@
+module CadmusNavbar
+  class Renderer
+    include ActionView::Helpers::OutputSafetyHelper
+
+    attr_accessor :request, :current_uri, :root_items, :items_by_section_id
+
+    def initialize(request:, url_for_page:, items_by_section_id: nil, root_items: nil)
+      @_url_for_page = url_for_page
+      @request = request
+      @current_uri = URI.parse(request.url)
+      @items_by_section_id = items_by_section_id
+
+      if !items_by_section_id && root_items
+        @items_by_section_id = root_items.flat_map { |item| [item, *item.navigation_links] }
+          .group_by(&:navigation_section_id)
+      end
+    end
+
+    def self.from_parent(parent:, **args)
+      items = CadmusNavbar.navigation_item_model.where(
+        parent_id: parent.id,
+        parent_type: parent.class.base_class.name
+      ).root.includes(:page).group_by(&:navigation_section_id)
+      self.new(items_by_section_id: items.to_a, **args)
+    end
+
+    def root_items
+      items_by_section_id[nil] || []
+    end
+
+    def render_navigation_items
+      rendered_items = root_items.sort_by(&:position).map { |item| render_navigation_item(item) }
+      safe_join(rendered_items)
+    end
+
+    def render_navigation_item(item)
+      case item.item_type
+      when 'section'
+        render_navigation_section(item, (items_by_section_id[item.id] || []).sort_by(&:position))
+      when 'link'
+        render_navigation_link(item, root: true)
+      end
+    end
+
+    def render_navigation_section(item)
+      raise '#render_navigation_section must be implemented by subclasses'
+    end
+
+    def render_navigation_link(item, root:)
+      raise '#render_navigation_link must be implemented by subclasses'
+    end
+
+    def navigation_link_is_active?(item)
+      return false unless item && item.page
+
+      page_uri = URI.parse(url_for_page(item.page))
+      page_uri.path == current_uri.path
+    end
+
+    def url_for_page(page)
+      @_url_for_page.call(page)
+    end
+  end
+end

data/lib/cadmus_navbar/renderers.rb

@@ -0,0 +1,6 @@
+module CadmusNavbar
+  module Renderers
+    extend ActiveSupport::Autoload
+    autoload :Bootstrap4
+  end
+end

data/lib/cadmus_navbar/renderers/bootstrap4.rb

@@ -0,0 +1,45 @@
+module CadmusNavbar
+  module Renderers
+    class Bootstrap4 < CadmusNavbar::Renderer
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::UrlHelper
+      include ActionView::Context
+
+      def render_navigation_section(section, links)
+        content_tag(:li, class: 'nav-item dropdown') do
+          safe_join([
+            content_tag(:a, section.title, class: "nav-link dropdown-toggle", "data-toggle" => "dropdown", role: "button", "aria-haspopup" => "true", "aria-expanded" => "false"),
+            content_tag(:div, class: 'dropdown-menu') do
+              safe_join(links.map { |item| render_navigation_link(item, root: false) })
+            end
+          ])
+        end
+      end
+
+      def render_navigation_link(item, root:)
+        is_active = navigation_link_is_active?(item)
+        item_class = class_for_navigation_link(root)
+
+        classes = [item_class]
+        classes << 'active' if is_active
+
+        link_to url_for_page(item.page), class: classes.join(' ') do
+          safe_join(
+            [
+              item.title,
+              (is_active ? content_tag(:span, ' (current)', class: 'sr-only') : nil)
+            ].compact
+          )
+        end
+      end
+
+      def class_for_navigation_link(root)
+        if root
+          'nav-item nav-link'
+        else
+          'dropdown-item'
+        end
+      end
+    end
+  end
+end

data/lib/cadmus_navbar/version.rb

@@ -0,0 +1,3 @@
+module CadmusNavbar
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: cadmus_navbar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nat Budin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: cadmus
+  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'
+- !ruby/object:Gem::Dependency
+  name: acts_as_list
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds models and renderers for navigation bars to the Cadmus micro-CMS
+email:
+- natbudin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- app/views/cadmus/navigation_items/index.html.erb
+- bin/console
+- bin/setup
+- cadmus_navbar.gemspec
+- lib/cadmus_navbar.rb
+- lib/cadmus_navbar/admin_controller.rb
+- lib/cadmus_navbar/engine.rb
+- lib/cadmus_navbar/navigation_item.rb
+- lib/cadmus_navbar/renderer.rb
+- lib/cadmus_navbar/renderers.rb
+- lib/cadmus_navbar/renderers/bootstrap4.rb
+- lib/cadmus_navbar/version.rb
+homepage: https://github.com/nbudin/cadmus_navbar
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Adminable navigation bars for Cadmus sites
+test_files: []