fronton 0.1.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4ea27d21a7fcbac4a66a2266e4bd76851a8f21f
+  data.tar.gz: a14b250d931a46b335928e6546d0d1016ef6d59b
+SHA512:
+  metadata.gz: 8b54192e91e2e0b9f7ffd1d3427311b3673b40d1665a8f348f04a06b33e68e4e642a94d128af3aa866f35c986fce697f6ede3b0389932036c10627ab60e9a3af
+  data.tar.gz: 2965585b4697e93a81b7deefa9e431cbcfab67133dc4e6592d9b24edec0510a0e8e90f08b4cb72b9d07ae780e35f9046c9a484ea194c589fca118ce02fe0fab9

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright © 2016 Javier Aranda
+
+MIT License
+
+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,42 @@
+# Fronton
+
+A command-line tool for build frontend apps in Ruby.
+
+
+## Status
+
+> **This project is still experimental, use with caution!**
+
+
+## Installation
+
+```
+$ gem install fronton
+```
+
+`TODO`: Write an advanced installation guide
+
+
+## Usage
+
+`TODO`: Write usage instructions here
+
+
+## Testing
+
+`TODO`: Write how to test
+
+
+## Contributing
+
+Contributions are welcome, please follow [GitHub Flow](https://guides.github.com/introduction/flow/index.html)
+
+
+## Versioning
+
+**fronton** uses [Semantic Versioning 2.0.0](http://semver.org)
+
+
+## License
+
+Copyright © 2016 Javier Aranda. Released under [MIT](LICENSE.md) license.

data/bin/fronton

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'fronton'
+
+Fronton::CLI.start

data/fronton.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/fronton/version'
+require 'date'
+
+Gem::Specification.new do |spec|
+  #
+  ## INFORMATION
+  #
+  spec.name = 'fronton'
+  spec.version = Fronton.version
+  spec.summary = 'A command-line tool for build frontend apps in Ruby'
+  spec.description = nil
+  spec.author = 'Javier Aranda'
+  spec.email = 'javier.aranda.varo@gmail.com'
+  spec.license = 'MIT'
+  spec.date = Date.today.strftime('%Y-%m-%d')
+  spec.homepage = 'https://github.com/javierav/fronton'
+
+  #
+  ## GEM
+  #
+  spec.bindir = 'bin'
+  spec.require_paths = %w(lib)
+  spec.files = `git ls-files -z -- lib bin template LICENSE README.md fronton.gemspec`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.extra_rdoc_files = %w(README.md LICENSE)
+  spec.required_ruby_version = '~> 2.3'
+
+  #
+  ## DEPENDENCIES
+  #
+  spec.add_dependency 'thor',      '~> 0.19', '>= 0.19.1'
+  spec.add_dependency 'rack',      '~> 2.0', '>= 2.0.1'
+  spec.add_dependency 'sprockets', '~> 3.7'
+end

data/lib/fronton/assets_helpers.rb

@@ -0,0 +1,24 @@
+module Fronton
+  class AssetsHelpers
+    def initialize(options = {})
+      @use_digest = options.fetch(:digest, false)
+      @prefix     = options.fetch(:prefix, 'assets')
+      @manifest   = options.fetch(:manifest)
+    end
+
+    def javascript_tag(name)
+      name = asset_path("#{name}.js")
+      %(<script src="#{name}"></script>\n)
+    end
+
+    def stylesheet_tag(name)
+      name = asset_path("#{name}.css")
+      %(<link href="#{name}" media="screen" rel="stylesheet" />\n)
+    end
+
+    def asset_path(name)
+      asset_name = @use_digest && @manifest.assets[name] ? @manifest.assets[name] : name
+      "#{@prefix}/#{asset_name}"
+    end
+  end
+end

data/lib/fronton/cli.rb

@@ -0,0 +1,151 @@
+require 'fileutils'
+require 'rack'
+require 'thor'
+require 'fronton/config'
+require 'fronton/html_server'
+
+module Fronton
+  class CLI < Thor
+    include Thor::Actions
+
+    def self.source_root
+      File.expand_path('../../..', __FILE__)
+    end
+
+    no_commands do
+      def config
+        if !@config.is_a?(Fronton::Config) && @config.respond_to?(:call)
+          @config = @config.call
+        else
+          @config
+        end
+      end
+    end
+
+    def initialize(*args)
+      super(*args)
+      @config = -> { Fronton::Config.load! }
+    end
+
+    desc 'new APP_NAME', 'Creates new frontend app'
+    def new(name)
+      if Dir.exist? name
+        say_status 'create', "#{name} directory already exists. Abort!", :red
+        exit 1
+      else
+        directory 'template', name
+      end
+    end
+
+    desc 'server', 'Preview your app in browser'
+    method_option :port, type: :numeric, default: 3000, banner: 'PORT the server listen port'
+    def server # rubocop:disable Metrics/AbcSize
+      # install dependencies for rails assets
+      config.install_dependencies
+
+      # require dependencies for rails assets
+      config.require_dependencies
+
+      conf = config
+
+      app = Rack::Builder.new do
+        map('/assets') { run conf.environment }
+        map('/') { run Fronton::HTMLServer.new(config: conf) }
+      end
+
+      Rack::Server.start(
+        app: app,
+        environment: 'development',
+        Port: options[:port]
+      )
+    end
+
+    desc 'compile', 'Compiles assets using digest and minification'
+    def compile # rubocop:disable Metrics/AbcSize
+      # install dependencies for rails assets
+      config.install_dependencies
+
+      # require dependencies for rails assets
+      config.require_dependencies
+
+      # configure environment
+      if config.compressor_js
+        config.environment.js_compressor  = config.compressor_js.to_sym
+      end
+
+      if config.compressor_css
+        config.environment.css_compressor = config.compressor_css.to_sym
+      end
+
+      # compile assets
+      config.manifest.compile(config.assets)
+
+      # compile html pages
+      config.pages.map(&:save)
+    end
+
+    desc 'clean', 'Remove old assets'
+    method_option :keep, type: :numeric, default: 2, banner: 'KEEP assets versions to keep'
+    def clean
+      config.manifest.clean(options[:keep])
+    end
+
+    desc 'clobber', 'Remove all assets'
+    def clobber
+      # assets
+      config.manifest.clobber
+
+      # html
+      FileUtils.rm Dir.glob(config.output.join('*.html'))
+    end
+
+    desc 'info', 'Information about project'
+    def info # rubocop:disable Metrics/AbcSize
+      say 'Dependencies', :bold
+
+      @dependencies = config.dependencies.map do |dep|
+        status = dep.available? ? 'Installed' : 'Not Installed'
+        [dep.name, dep.version, status]
+      end
+
+      print_table @dependencies
+
+      puts ''
+
+      say 'Assets Paths', :bold
+      config.assets_paths.each { |path| puts path.to_s }
+
+      puts ''
+
+      say 'Pages Paths', :bold
+      config.pages_paths.each { |path| puts path.to_s }
+
+      puts ''
+
+      say 'Sprockets Engines', :bold
+
+      @engines = config.environment.engines.map { |ext, klass| [ext, klass] }
+      print_table @engines
+
+      puts ''
+
+      say 'Compressors', :bold
+
+      @available_compressors = []
+      @used_compressors = [config.compressor_css.to_sym, config.compressor_js.to_sym]
+
+      config.environment.compressors.each do |mime, list|
+        list.each do |id, klass|
+          mark = @used_compressors.include?(id) ? '<--' : ''
+          @available_compressors << [mime, id, klass, mark]
+        end
+      end
+
+      print_table @available_compressors
+
+      puts ''
+
+      say "Powered by Fronton v#{Fronton.version} - https://github.com/javierav/fronton", :bold
+    end
+  end
+end

data/lib/fronton/config.rb

@@ -0,0 +1,128 @@
+require 'pathname'
+require 'logger'
+require 'yaml'
+require 'sprockets'
+require 'fronton/dependency'
+
+module Fronton
+  class Config
+    class YAMLNotFound < StandardError; end
+
+    def self.load!
+      file = Pathname.pwd.join('fronton.yml')
+
+      if file.exist?
+        self.new( YAML.load_file(file) )
+      else
+        raise YAMLNotFound, "File 'fronton.yml' not found in #{Dir.pwd}"
+      end
+    end
+
+    def initialize(parsed_yaml)
+      @config       = parsed_yaml
+      @logger       = Logger.new($stderr)
+      @logger.level = Logger::INFO
+    end
+
+    #
+    ## ACCESSORS
+    #
+
+    def assets
+      @assets ||= @config['assets'].is_a?(Array) ? @config['assets'] : []
+    end
+
+    def assets_paths
+      @assets_paths ||= begin
+        if @config['assets_paths'].is_a?(Array)
+          @config['assets_paths'].map { |p| working_dir.join(p) }
+        else
+          []
+        end
+      end
+    end
+
+    def output
+      @output ||= working_dir.join(@config['output'] || 'public')
+    end
+
+    def dependencies
+      @dependencies ||= begin
+        dep = @config['dependencies'].is_a?(Array) ? @config['dependencies'] : []
+
+        dep.map do |d|
+          Dependency.new(d.keys.first, d.values.first)
+        end
+      end
+    end
+
+    def pages
+      @pages ||= begin
+        pages = @config['pages'].is_a?(Array) ? @config['pages'] : []
+
+        pages.map do |page|
+          Page.new(page.keys.first, page.values.first, config: self)
+        end
+      end
+    end
+
+    def pages_paths
+      @pages_paths ||= begin
+        if @config['pages_paths'].is_a?(Array)
+          @config['pages_paths'].map { |p| working_dir.join(p) }
+        else
+          []
+        end
+      end
+    end
+
+    def compressor_js
+      @config['compressors'] && @config['compressors']['js']
+    end
+
+    def compressor_css
+      @config['compressors'] && @config['compressors']['css']
+    end
+
+    def environment
+      @environment ||= begin
+        env = Sprockets::Environment.new
+
+        # logger
+        env.logger = @logger
+
+        # fronton.yml assets paths
+        assets_paths.each { |path| env.append_path path }
+
+        # rails assets paths
+        if defined? RailsAssets
+          RailsAssets.load_paths.each { |path| env.append_path path }
+        end
+
+        env
+      end
+    end
+
+    def manifest
+      @manifest ||= Sprockets::Manifest.new environment, File.join(output, 'assets', 'manifest.json')
+    end
+
+    #
+    ## METHODS
+    #
+
+    def install_dependencies
+      dependencies.map(&:install_dependency)
+    end
+
+    def require_dependencies
+      dependencies.map(&:require_dependency)
+    end
+
+    private
+
+    def working_dir
+      Pathname.pwd
+    end
+  end
+end

data/lib/fronton/dependency.rb

@@ -0,0 +1,27 @@
+module Fronton
+  class Dependency
+    attr_reader :name, :version
+
+    def initialize(name, version)
+      @name = name
+      @version = version
+    end
+
+    def available?
+      Gem::Specification.find_by_name(@name, @version) && true
+    rescue Gem::LoadError => _
+      false
+    end
+
+    def install_dependency
+      Gem.install @name, @version unless available?
+    end
+
+    def require_dependency
+      # activate gem
+      gem @name, @version
+      # require gem
+      require @name
+    end
+  end
+end

data/lib/fronton/html_server.rb

@@ -0,0 +1,37 @@
+require 'fronton/page'
+
+module Fronton
+  class HTMLServer
+    def initialize(options = {})
+      @config = options.fetch(:config)
+    end
+
+    # Rack entrypoint
+    def call(env)
+      if page = requested_page(env) # rubocop:disable Lint/AssignmentInCondition
+
+        if page.exist?
+          render_page(page)
+        else
+          error_404
+        end
+      else
+        error_404
+      end
+    end
+
+    private
+
+    def requested_page(env)
+      @config.pages.find { |page| page.url == env['PATH_INFO'] }
+    end
+
+    def render_page(page)
+      [200, { 'Content-Type' => 'text/html' }, [page.content]]
+    end
+
+    def error_404
+      [404, { 'Content-Type' => 'text/plain' }, ['Not Found']]
+    end
+  end
+end

data/lib/fronton/page.rb

@@ -0,0 +1,57 @@
+require 'tilt'
+require 'fronton/assets_helpers'
+
+module Fronton
+  class Page
+    attr_reader :name, :url, :config
+
+    def initialize(name, url, options = {})
+      @name   = name
+      @config = options.fetch(:config)
+      @digest = options.fetch(:digest, false)
+      @url    = url
+    end
+
+    def content
+      Tilt.new(template_path, template_options).render(AssetsHelpers.new(helpers_options))
+    end
+
+    def save
+      with_digest do
+        File.open(save_path, 'w') { |f| f.write(content) }
+      end
+    end
+
+    def exist?
+      !template_path.nil?
+    end
+
+    private
+
+    def template_path
+      found_path = config.pages_paths.find do |path|
+        File.exist?(path.join(name))
+      end
+
+      found_path = found_path.join(name) if found_path
+
+      found_path
+    end
+
+    def template_options
+      { disable_escape: true, pretty: true }
+    end
+
+    def helpers_options
+      { digest: @digest, manifest: @config.manifest }
+    end
+
+    def save_path
+      config.output.join("#{File.basename(name, '.*')}.html")
+    end
+
+    def with_digest
+      @digest = true; yield; @digest = false # rubocop:disable Style/Semicolon
+    end
+  end
+end

data/lib/fronton/version.rb

@@ -0,0 +1,18 @@
+module Fronton
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    PRE   = 'alpha'.freeze
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+
+  def self.version
+    VERSION::STRING
+  end
+
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+end

data/lib/fronton.rb

@@ -0,0 +1,2 @@
+require 'fronton/version'
+require 'fronton/cli'

data/template/fronton.yml

@@ -0,0 +1,20 @@
+assets:
+  - application.js
+  - application.css
+assets_paths:
+  - assets/javascripts
+  - assets/stylesheets
+  - assets/fonts
+  - assets/images
+  - vendor/javascripts
+  - vendor/stylesheets
+  - vendor/fonts
+  - vendor/images
+dependencies:
+  - rails-assets-jquery: 3.1.0
+  - slim: 3.0.7
+output: public
+pages:
+  - index.slim: /
+pages_paths:
+  - pages

data/template/locales/es/index.yml

@@ -0,0 +1,3 @@
+es:
+  index:
+    title: "Index"

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: fronton
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha
+platform: ruby
+authors:
+- Javier Aranda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: ''
+email: javier.aranda.varo@gmail.com
+executables:
+- fronton
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- bin/fronton
+- fronton.gemspec
+- lib/fronton.rb
+- lib/fronton/assets_helpers.rb
+- lib/fronton/cli.rb
+- lib/fronton/config.rb
+- lib/fronton/dependency.rb
+- lib/fronton/html_server.rb
+- lib/fronton/page.rb
+- lib/fronton/version.rb
+- template/assets/fonts/.keep
+- template/assets/images/.keep
+- template/assets/javascripts/.keep
+- template/assets/stylesheets/.keep
+- template/fronton.yml
+- template/locales/es/index.yml
+- template/pages/partials/.keep
+- template/public/.keep
+- template/vendor/fonts/.keep
+- template/vendor/images/.keep
+- template/vendor/javascripts/.keep
+- template/vendor/stylesheets/.keep
+homepage: https://github.com/javierav/fronton
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: A command-line tool for build frontend apps in Ruby
+test_files: []