mintaka 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10a6a8b96df3a2ac999428317e15605663be2677
+  data.tar.gz: 0d0af8ead17dfe39b9d839b3d2b82c3ca5e49727
+SHA512:
+  metadata.gz: b7dd92b2e47976e6b0d3c896f0bcbd016c81dce28ca2eeb7e1c0699714a6dc3810699466a6bab8f696950d30bdd6a8c19c22a670b60dc0f97edc018cb43a14f3
+  data.tar.gz: 5bfd88f49ddb1660e4dab508154d79d5473ad8f1b3d2c5afcbf3041f17daf53440483f06929f48b4956f7856756da59c6b23038cb3ad06dac828b01b0ae5a6d7

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "appraisal"
+gem "rspec-rails", "~> 3.5.0"

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 jcottobboni
+
+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,28 @@
+# Mintaka
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mintaka'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install mintaka
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mintaka'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/concerns/mintaka/static_page.rb

@@ -0,0 +1,39 @@
+module Mintaka::StaticPage
+  extend ActiveSupport::Concern
+
+  included do
+    layout ->(_) { Mintaka.layout }
+
+    rescue_from ActionView::MissingTemplate do |exception|
+      if exception.message =~ %r{Missing template #{page_finder.content_path}}
+        invalid_page
+      else
+        raise exception
+      end
+    end
+
+    rescue_from Mintaka::InvalidPageIdError, with: :invalid_page
+  end
+
+  def show
+    render template: current_page
+  end
+
+  def invalid_page
+    raise ActionController::RoutingError, "No such page: #{params[:id]}"
+  end
+
+  private
+
+  def current_page
+    page_finder.find
+  end
+
+  def page_finder
+    page_finder_factory.new(params[:id])
+  end
+
+  def page_finder_factory
+    Mintaka::PageFinder
+  end
+end

data/app/controllers/mintaka/pages_controller.rb

@@ -0,0 +1,3 @@
+class Mintaka::PagesController < ApplicationController
+  include Mintaka::StaticPage
+end

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/mintaka/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,10 @@
+Mintaka.parent_engine.routes.draw do
+  if Mintaka.home_page
+    get "/#{Mintaka.home_page}", to: redirect('/')
+    root to: 'mintaka/pages#show', id: Mintaka.home_page
+  end
+
+  if Mintaka.routes
+    get Mintaka.route_drawer.match_attributes
+  end
+end

data/lib/mintaka.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/module/attribute_accessors'
+
+require 'mintaka/configuration'
+require 'mintaka/constraints/root_route'
+require "mintaka/page"
+require "mintaka/page_collector"
+require 'mintaka/page_finder'
+require 'mintaka/route_drawers/default'
+require 'mintaka/route_drawers/root'
+require 'mintaka/version'
+
+module Mintaka
+  extend Configuration
+  require 'mintaka/engine' if defined?(Rails)
+end

data/lib/mintaka/configuration.rb

@@ -0,0 +1,36 @@
+module Mintaka
+  module Configuration
+    attr_accessor(
+      :content_path,
+      :home_page,
+      :layout,
+      :parent_engine,
+      :route_drawer,
+      :routes,
+    )
+
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.set_default_configuration
+    end
+
+    def page_ids
+      Mintaka::PageCollector.new(Mintaka.full_path).page_ids
+    end
+
+    def full_path
+      Rails.root.join("app", "views", Mintaka.content_path)
+    end
+
+    def set_default_configuration
+      self.content_path = 'pages/'
+      self.home_page = nil
+      self.layout = 'application'
+      self.route_drawer = Mintaka::RouteDrawers::Default
+      self.routes = true
+    end
+  end
+end

data/lib/mintaka/constraints/root_route.rb

@@ -0,0 +1,29 @@
+module Mintaka
+  module Constraints
+    # Routing constraint to validate request.path has a corresponding view
+    class RootRoute
+      class << self
+        def matches?(request)
+          page_id = clean_page_path(request.path)
+          pattern = file_pattern(page_id)
+
+          Dir.glob(pattern).any?
+        end
+
+        private
+
+        def clean_page_path(request_path)
+          request_path.sub(/\.html$/, "")
+        end
+
+        def file_pattern(page_id)
+          "#{content_path}#{page_id}.html*"
+        end
+
+        def content_path
+          Rails.root.join("app", "views", Mintaka.content_path).to_s
+        end
+      end
+    end
+  end
+end

data/lib/mintaka/engine.rb

@@ -0,0 +1,22 @@
+module Mintaka
+  class Engine < Rails::Engine
+    initializer "Set up default parent engine" do |app|
+      Mintaka.parent_engine ||= Rails.application
+    end
+
+    initializer "Require concerns path" do |app|
+      concerns_path = "app/controllers/concerns"
+
+      unless app.paths.keys.include?(concerns_path)
+        app.paths.add(concerns_path)
+      end
+    end
+
+    initializer "Require for Rails 3" do |app|
+      if defined?(Rails) && Rails::VERSION::MAJOR == 3
+        require "concerns/mintaka/static_page"
+        require "mintaka/pages_controller"
+      end
+    end
+  end
+end

data/lib/mintaka/page.rb

@@ -0,0 +1,44 @@
+module Mintaka
+  class Page
+    attr_reader :content_path, :file_path
+
+    def initialize(content_path, file_path)
+      @content_path = content_path
+      @file_path = file_path
+    end
+
+    def id
+      file_path.gsub(content_path, "").gsub(html_file_pattern, "")
+    end
+
+    def valid?
+      exists? && file_in_content_path? && !directory? && !partial? && html?
+    end
+
+    private
+
+    def exists?
+      File.exists?(file_path)
+    end
+
+    def file_in_content_path?
+      file_path.start_with?(content_path)
+    end
+
+    def directory?
+      FileTest.directory?(file_path)
+    end
+
+    def partial?
+      File.basename(file_path).first == "_"
+    end
+
+    def html?
+      !file_path.match(html_file_pattern).nil?
+    end
+
+    def html_file_pattern
+      /\.(html)(\.[a-z]+)?$/
+    end
+  end
+end

data/lib/mintaka/page_collector.rb

@@ -0,0 +1,23 @@
+module Mintaka
+  require "find"
+
+  class PageCollector
+    attr_reader :content_path
+
+    def initialize(content_path)
+      @content_path = content_path.to_s
+    end
+
+    def page_ids
+      pages.select(&:valid?).map(&:id)
+    end
+
+    private
+
+    def pages
+      Find.find(content_path).map do |file_path|
+        Mintaka::Page.new(content_path, file_path)
+      end
+    end
+  end
+end

data/lib/mintaka/page_finder.rb

@@ -0,0 +1,51 @@
+module Mintaka
+  # A command for finding pages by id. This encapsulates the concepts of
+  # mapping page names to file names.
+  class PageFinder
+    VALID_CHARACTERS = "a-zA-Z0-9~!@$%^&*()#`_+-=<>\"{}|[];',?".freeze
+
+    def initialize(page_id)
+      @page_id = page_id
+    end
+
+    # Produce a template path to the page, in a format understood by
+    # `render :template => find`
+    def find
+      "#{content_path}#{clean_path}"
+    end
+
+    def content_path
+      Mintaka.content_path
+    end
+
+    protected
+
+    # The raw page id passed in by the user
+    attr_reader :page_id
+
+    private
+
+    def clean_path
+      path = Pathname.new("/#{clean_id}")
+      path.cleanpath.to_s[1..-1].tap do |p|
+        if p.blank?
+          raise InvalidPageIdError.new "Invalid page id: #{@page_id}"
+        end
+      end
+    end
+
+    def clean_id
+      @page_id.tr("^#{VALID_CHARACTERS}", "").tap do |id|
+        if invalid_page_id?(id)
+          raise InvalidPageIdError.new "Invalid page id: #{@page_id}"
+        end
+      end
+    end
+
+    def invalid_page_id?(id)
+      id.blank? || (id.first == ".")
+    end
+  end
+
+  class InvalidPageIdError < StandardError; end
+end

data/lib/mintaka/route_drawers/default.rb

@@ -0,0 +1,15 @@
+module Mintaka
+  module RouteDrawers
+    # Matches routes in the Mintaka.content_path directory. By default this looks
+    # for /pages/id. e.g. http://www.example.com/pages/about_us
+    class Default
+      def self.match_attributes
+        {
+          "/#{Mintaka.content_path}*id" => 'mintaka/pages#show',
+          :as => :page,
+          :format => false
+        }
+      end
+    end
+  end
+end

data/lib/mintaka/route_drawers/root.rb

@@ -0,0 +1,16 @@
+module Mintaka
+  module RouteDrawers
+    # Matches routes from root of the domain e.g. http://www.example.com/about_us
+    # Uses Mintaka::Constraints::RootRoute to validate view exists.
+    class Root
+      def self.match_attributes
+        {
+          "/*id" => 'mintaka/pages#show',
+          :as => :page,
+          :format => false,
+          :constraints => Mintaka::Constraints::RootRoute
+        }
+      end
+    end
+  end
+end

data/lib/mintaka/version.rb

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

data/lib/tasks/mintaka_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mintaka do
+#   # Task goes here
+# end

data/mintaka.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "mintaka/version"
+
+$:.push File.expand_path("../lib", __FILE__)
+require "mintaka/version"
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "mintaka"
+  s.version     = Mintaka::VERSION
+  s.authors     = ["jcottobboni"]
+  s.email       = ["jcottobboni@gmail.com"]
+  s.homepage    = "http://www.google.com"
+  s.summary     = "Engine for statics pages"
+  s.description = "provides statics page inserts and control"
+  s.license     = "MIT"
+
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", "~> 5.0.2"
+
+  s.add_development_dependency("activesupport", ">= 3.1.0")
+  s.add_development_dependency("pry")
+end

data/test/integration/navigation_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  # test "the truth" do
+  #   assert true
+  # end
+end
+

data/test/mintaka_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class Mintaka::Test < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Mintaka
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../../test/dummy/config/environment.rb", __FILE__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
+require "rails/test_help"
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+  ActiveSupport::TestCase.file_fixture_path = ActiveSupport::TestCase.fixture_path + "/files"
+  ActiveSupport::TestCase.fixtures :all
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: mintaka
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jcottobboni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-02 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.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: provides statics page inserts and control
+email:
+- jcottobboni@gmail.com
+executables:
+- rails
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/mintaka_manifest.js
+- app/assets/images/mintaka/.keep
+- app/assets/javascripts/mintaka/.keep
+- app/assets/stylesheets/mintaka/.keep
+- app/controllers/.keep
+- app/controllers/concerns/mintaka/static_page.rb
+- app/controllers/mintaka/pages_controller.rb
+- app/helpers/.keep
+- app/mailers/.keep
+- app/models/.keep
+- app/views/.keep
+- bin/rails
+- config/routes.rb
+- lib/mintaka.rb
+- lib/mintaka/configuration.rb
+- lib/mintaka/constraints/root_route.rb
+- lib/mintaka/engine.rb
+- lib/mintaka/page.rb
+- lib/mintaka/page_collector.rb
+- lib/mintaka/page_finder.rb
+- lib/mintaka/route_drawers/default.rb
+- lib/mintaka/route_drawers/root.rb
+- lib/mintaka/version.rb
+- lib/tasks/mintaka_tasks.rake
+- mintaka.gemspec
+- test/integration/navigation_test.rb
+- test/mintaka_test.rb
+- test/test_helper.rb
+homepage: http://www.google.com
+licenses:
+- MIT
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Engine for statics pages
+test_files: []