lb-project 0.0.1

data/lib/lb/project/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Version
+    VERSION = '0.0.1'
+  end
+end

data/lib/lb/project/view.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Base view
+    class View < Dry::View::Controller
+      extend LB::Project::Registry::Registration[:view]
+
+      def self.setup(view)
+        view.setting :paths, [LB::Project.template_path]
+        view.setting :layout, 'main'
+      end
+
+      def view_locals(options)
+        options
+      end
+    end
+  end
+end

data/lib/lb/project.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'yaml'
+
+# Web
+require 'roda'
+require 'roda/plugins/public'
+
+# r18n
+require 'r18n-core'
+
+# Dry
+require 'dry-types'
+require 'dry-struct'
+require 'dry-view'
+require 'dry-initializer'
+
+# Version
+require 'lb/project/version'
+
+# Custom Types
+require 'lb/project/types'
+
+# Config
+require 'lb/project/config'
+
+# LB namespace
+module LB
+  # Project
+  module Project
+    CONFIG_NAME = 'application'
+    DEFAULT_RACK_ENV = 'development'
+
+    # Setup
+    #
+    # @param [File] root Path to project root
+    #
+    # @return [self]
+    #
+    # @api private
+    #
+    def self.setup(root)
+      @root = root
+
+      self
+    end
+
+    # Get root path
+    #
+    # @return [dir_name]
+    #
+    # @api private
+    #
+    def self.root
+      @root
+    end
+
+    # Get root path for file
+    #
+    # @param [File] file The file to get the root path from
+    # @param [File] depth The depth of the given file relative from the root
+    # directory
+    #
+    # @return [dir_name]
+    #
+    # @api private
+    #
+    def self.root_for(file, depth = 2)
+      path = File.expand_path(file)
+      depth.times { path = File.dirname(path) }
+      path
+    end
+
+    # Get template path
+    #
+    # @return [dir_name]
+    #
+    # @api private
+    #
+    def self.template_path
+      File.join(root, config.template_path)
+    end
+
+    # Get public path
+    #
+    # @return [dir_name]
+    #
+    # @api private
+    #
+    def self.public_path
+      File.join(root, config.public_path)
+    end
+
+    # Get main configuration
+    #
+    # @return [Config]
+    #
+    # @api private
+    #
+    def self.config
+      @config ||= Config.load(root, CONFIG_NAME, rack_env)
+    end
+
+    # Get RACK_ENV
+    #
+    # @return [String]
+    #
+    # @api private
+    #
+    def self.rack_env
+      @rack_env ||= ENV.fetch('RACK_ENV', DEFAULT_RACK_ENV)
+    end
+
+    # Check if rack_env is 'development'
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    #
+    def self.development?
+      DEFAULT_RACK_ENV.eql? rack_env
+    end
+
+    def self.t(*params)
+      R18n.t(*params)
+    end
+
+    def self.logger
+      @logger ||= create_logger
+    end
+
+    def self.create_logger
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::INFO
+      logger
+    end
+
+    private_class_method :create_logger
+  end
+end
+
+# Site
+require 'lb/project/site'
+
+# Routing
+require 'lb/project/route'
+require 'lb/project/app'
+
+# Registry
+require 'lb/project/registry'
+require 'lb/project/registry/registration'
+
+# Views
+require 'lb/project/view'
+require 'lb/project/page'
+
+# Render
+require 'lb/project/render'

data/lib/lb-project.rb

@@ -0,0 +1,5 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'lb/project'
+# rubocop:enable Naming/FileName

data/rakelib/ci.rake

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Remove existing same-named tasks
+%w[ci ci:metrics].each do |task|
+  klass = Rake::Task
+  klass[task].clear if klass.task_defined?(task)
+end
+
+desc 'Run all specs, metrics and mutant'
+task ci: %w[ci:metrics metrics:mutant]
+
+namespace :ci do
+  tasks = %w[
+    metrics:coverage
+    metrics:yardstick:verify
+    metrics:rubocop
+    metrics:flog
+    metrics:flay
+    spec:integration
+  ]
+
+  desc 'Run metrics (except mutant)'
+  task metrics: tasks
+end

data/spec/fixtures/config/application.yml

@@ -0,0 +1,10 @@
+development: &base
+  base_path : ''
+  image_base_path: 'assets/images'
+  public_path: 'docs'
+  template_path: 'templates'
+test:
+  <<: *base
+production:
+  <<: *base
+  public_path: 'htdocs'

data/spec/fixtures/config/lb-project.yml

@@ -0,0 +1,3 @@
+---
+namespace: example
+

data/spec/fixtures/config.ru

@@ -0,0 +1,9 @@
+#\ -p 3000 -P invalid_public_path_to_disable_shotguns_static_route
+# frozen_string_literal: true
+
+root = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH << File.join(root, 'lib')
+
+require 'example'
+
+run Example::App.freeze.app

data/spec/fixtures/lib/example/app.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Example
+  # Main routing entry point
+  class App < LB::Project::App
+    LB::Project::Route.setup(self)
+
+    route do |r|
+      r.i18n_set_locale_from(:http)
+
+      r.public
+    end
+  end
+end

data/spec/fixtures/lib/example/page/index.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Example
+  class Page
+    # The index page
+    class Index < self
+      setting :template, 'index'
+
+      register_page_as :index
+      register_view_as :index
+    end
+  end
+end

data/spec/fixtures/lib/example/page.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Example
+  # Base page
+  class Page < LB::Project::Page
+    LB::Project::View.setup(self)
+  end
+end

data/spec/fixtures/lib/example.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Slim
+require 'slim'
+
+require 'lb-project'
+
+# Example project
+module Example
+  LB::Project.setup(LB::Project.root_for(__FILE__))
+end
+
+require 'example/app'
+require 'example/page'
+require 'example/page/index'

data/spec/fixtures/locales/en.yml

@@ -0,0 +1,7 @@
+site:
+  title: lb-rb.org
+  logo: Logo
+
+page:
+  index:
+    title: lb-rb.org

data/spec/fixtures/templates/index.html.slim

@@ -0,0 +1,7 @@
+body
+  h1 lb-rb.org
+
+  #content
+    p
+      a href='https://github.com/lb-rb'
+       | Visit us at GitHub

data/spec/fixtures/templates/layouts/main.html.slim

@@ -0,0 +1,13 @@
+doctype html
+html
+  head
+    meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"
+    meta charset="utf-8"
+    meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport"
+
+    title = "#{_context.page.title} - #{site.t.site.title}"
+
+    link href="#{site.css_for('main')}" rel='stylesheet' type='text/css'
+    script src="#{site.js_for('main')}"
+
+  == yield

data/spec/fixtures/webpack-assets.json

@@ -0,0 +1 @@
+{"main":{"js":"assets/javascripts/main.bundle.js","css":"assets/stylesheets/main.bundle.css"}}

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+
+  SimpleCov.start do
+    command_name 'spec:unit'
+
+    add_filter 'config'
+    add_filter 'spec'
+
+    minimum_coverage 100
+  end
+end
+
+$LOAD_PATH << 'lib'
+
+require 'lb-project'
+
+require 'devtools/spec_helper'
+
+# require spec support files and shared behavior
+Dir[File.expand_path('../{support,shared}/**/*.rb', __FILE__)].each do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  config.include(SpecHelper)
+  config.mock_framework = :rspec
+end

data/spec/support/helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Spec Helper
+module SpecHelper
+end

data/spec/unit/lb/project/class_methods/config_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe LB::Project, '.config' do
+  subject { object.config }
+
+  let(:object) { described_class }
+
+  let(:default_hash) do
+    {
+      base_path: '',
+      image_base_path: 'assets/images',
+      public_path: 'docs',
+      template_path: 'templates'
+    }
+  end
+
+  let(:default) { LB::Project::Config.new(default_hash) }
+
+  let(:env) { 'RACK_ENV' }
+
+  before(:each) do
+    root = LB::Project.root_for(__FILE__, 6)
+    LB::Project.setup(File.join(root, 'spec/fixtures'))
+  end
+
+  after(:each) do
+    object.remove_instance_variable(:@rack_env)
+    object.remove_instance_variable(:@config)
+    object.remove_instance_variable(:@root)
+  end
+
+  context 'without RACK_ENV' do
+    it 'should return default config' do
+      expect(subject).to eql(default)
+    end
+  end
+
+  context 'with RACK_ENV=production' do
+    let(:production_hash) { default_hash.merge(public_path: 'htdocs') }
+    let(:production) { LB::Project::Config.new(production_hash) }
+    let(:rack_env) { 'production' }
+
+    before(:each) do
+      ENV[env] = rack_env
+    end
+
+    after(:each) do
+      ENV.delete(env)
+    end
+
+    it 'should return production config' do
+      expect(subject).to eql(production)
+    end
+  end
+end

data/spec/unit/lb/project/class_methods/development_quest_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe LB::Project, '.development?' do
+  subject { object.development? }
+
+  let(:object) { described_class }
+
+  let(:default) { 'development' }
+
+  let(:env) { 'RACK_ENV' }
+
+  after(:each) do
+    object.remove_instance_variable(:@rack_env)
+  end
+
+  context 'without RACK_ENV' do
+    it 'should return true' do
+      expect(subject).to be true
+    end
+  end
+
+  context 'with RACK_ENV=production' do
+    let(:rack_env) { 'production' }
+
+    before(:each) do
+      ENV[env] = rack_env
+    end
+
+    after(:each) do
+      ENV.delete(env)
+    end
+
+    it 'should return false' do
+      expect(subject).to be false
+    end
+  end
+end

data/spec/unit/lb/project/class_methods/logger_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe LB::Project, '.logger' do
+  subject { object.logger }
+
+  let(:object) { described_class }
+
+  let(:expected_level) { Logger::INFO }
+
+  let(:expected_type) { Logger }
+
+  after(:each) do
+    object.remove_instance_variable(:@logger)
+  end
+
+  it 'should return logger of type Logger' do
+    expect(subject.class).to be(expected_type)
+  end
+
+  it 'should set log level to info' do
+    expect(subject.level).to be(expected_level)
+  end
+end

data/spec/unit/lb/project/class_methods/rack_env_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe LB::Project, '.rack_env' do
+  subject { object.rack_env }
+
+  let(:object) { described_class }
+
+  let(:default) { 'development' }
+
+  let(:env) { 'RACK_ENV' }
+
+  after(:each) do
+    object.remove_instance_variable(:@rack_env)
+  end
+
+  context 'without RACK_ENV' do
+    it 'should return default RACK_ENV' do
+      expect(subject).to eql(default)
+    end
+  end
+
+  context 'with RACK_ENV=production' do
+    let(:rack_env) { 'production' }
+
+    before(:each) do
+      ENV[env] = rack_env
+    end
+
+    after(:each) do
+      ENV.delete(env)
+    end
+
+    it 'should return production' do
+      expect(subject).to eql(rack_env)
+    end
+  end
+end

data/spec/unit/lb/project/class_methods/root_for_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe LB::Project, '.root_for' do
+  subject { object.root_for(*args) }
+
+  let(:args)   { [file] }
+  let(:object) { described_class }
+  let(:file)   { __FILE__ }
+
+  let(:expected) { File.dirname(File.dirname(File.expand_path(file))) }
+
+  it 'should equal the absolute parent path (two directory levels up)' do
+    expect(subject).to eql(expected)
+  end
+
+  context 'with depth of 3' do
+    let(:args) { [file, 3] }
+    let(:expected) do
+      File.dirname(File.dirname(File.dirname(File.expand_path(file))))
+    end
+
+    it 'should equal the absolute parent path (two directory levels up)' do
+      expect(subject).to eql(expected)
+    end
+  end
+end

data/spec/unit/lb/project/class_methods/root_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe LB::Project, '.root' do
+  subject { object.root }
+
+  let(:object) { described_class }
+
+  context 'without setup' do
+    it 'should return nil' do
+      expect(subject).to be_nil
+    end
+  end
+
+  context 'without setup' do
+    let(:root) { double(:root) }
+
+    before(:each) do
+      object.setup(root)
+    end
+
+    after(:each) do
+      object.remove_instance_variable(:@root)
+    end
+
+    it 'should return nil' do
+      expect(subject).to be(root)
+    end
+  end
+end

data/spec/unit/lb/project/class_methods/setup_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe LB::Project, '.setup' do
+  subject { object.setup(root) }
+
+  let(:root)   { double(:root) }
+  let(:object) { described_class }
+
+  after(:each) do
+    object.remove_instance_variable(:@root)
+  end
+
+  it 'should return self' do
+    expect(subject).to eql(object)
+  end
+
+  it 'should set root' do
+    subject
+    expect(object.root).to be(root)
+  end
+end