amp-html 0.7.7

data/INSTALL.md

@@ -0,0 +1 @@
+**Thank you for installing amp-html!**

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 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/OWNERS.yaml

@@ -0,0 +1 @@
+- jonhue

data/README.md

@@ -0,0 +1,192 @@
+# [BETA] AMP-HTML - Reliable and high-:zap: apps with AMP & Rails
+
+<img src="https://travis-ci.org/slooob/amp-html.svg?branch=master" /> [![Gem Version](https://badge.fury.io/rb/amp-html.svg)](https://badge.fury.io/rb/amp-html) [![Code Climate](https://codeclimate.com/github/jonhue/amp-html/badges/gpa.svg)](https://codeclimate.com/github/jonhue/amp-html)
+
+AmpHtml is a universal solution to integrate the AMP Project (Accelerated Mobile Pages Project) into your Rails app with ease. It enables you to quickly spin-up, build and test your app with AMP, while fulfilling the app's unique requirements. It comes with a bunch of superpowers like user authentication, notifications, blogs, animations and support for assets in AMP.
+
+Use the powerful features of AMP to make your Rails app consistently fast, beautiful and high-performing across devices and distribution platforms.
+
+[**Follow the Getting Started Guide**](https://github.com/slooob/amp-html/wiki/Getting-started)
+
+---
+
+## Navigation
+
+* [Information](#information)
+    * [Quick info (Latest release, Dependencies)](#quick-info)
+    * [The AMP-HTML wiki](#the-amp-html-wiki)
+    * [Bug reports](#bug-reports)
+    * [Example applications](#example-applications)
+    * [Contributing](#contributing)
+* [Concept](#concept)
+* [Features](#features)
+* [Installation](#installation)
+    * [Generators](#generators)
+    * [Test and validate AMP](#test-and-validate-amp)
+* [Usage](#usage)
+    * [Helpers](#helpers)
+    * [SplitView](#splitview)
+* [Guides](#guides)
+* [Components](#components)
+* [Contributors](#contributors)
+* [License](#license)
+
+---
+
+## Information
+
+### Quick info
+
+#### Latest release: 0.7.7 (Pre-release)
+
+[**Changelog**](https://github.com/slooob/amp-html/blob/master/CHANGELOG.md), [Grab it from Rubygems](https://rubygems.org/gems/amp-html)
+
+#### Supported versions
+
+    Rails >= 4.0.0
+    Ruby >= 2.0
+
+### The AMP-HTML wiki
+
+The AMP-HTML Wiki has lots of additional information about AMP-HTML including many "how-to" articles and answers to the most frequently asked questions. Please browse the Wiki after finishing this README:
+
+[https://github.com/slooob/amp-html/wiki](https://github.com/slooob/amp-html/wiki)
+
+### Bug reports
+
+If you discover a problem with AMP-HTML, we would like to know about it. However, we ask that you please review these guidelines before submitting a bug report:
+
+[https://github.com/slooob/amp-html/wiki/Bug-reports](https://github.com/slooob/amp-html/wiki/Bug-reports)
+
+If you have discovered a security related bug, please do *NOT* use the GitHub issue tracker. Send an email to [jonas@slooob.com](mailto:jonas@slooob.com).
+
+### Example applications
+
+There are a few example applications available on GitHub that demonstrate various features of AMP-HTML. You can view them here:
+
+[https://github.com/slooob/amp-html/wiki/Example-Applications](https://github.com/slooob/amp-html/wiki/Example-Applications)
+
+### Contributing
+
+We hope that you will consider contributing to AMP-HTML. Please read this short overview for some information about how to get started:
+
+[Contributing](https://github.com/slooob/amp-html/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/slooob/amp-html/blob/master/CODE_OF_CONDUCT.md)
+
+## Concept
+
+## Features
+
+## Installation
+
+You can also follow the [**Getting Started Guide**](https://github.com/slooob/amp-html/wiki/Getting-started).
+
+AMP-HTML works with Rails 4.0 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'amp-html'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amp-html
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'amp-html', github: 'https://github.com/slooob/amp-html.git'
+```
+
+### Generators
+
+AmpHtml comes with three different generators. If you want to bundle them execute:
+
+    $ rails g amp-html:bundle
+
+That will generate all the files you need to create a universal AMP app (recommended).
+
+If you want to use [SplitView](https://github.com/slooob/amp-html/wiki/Docs:-SplitView) to create views with and without AMP simultaneously, execute instead:
+
+    $ rails g amp-html:bundle --split
+
+To add components ([List of components](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/README.md)) to the generator simply include the component as an option:
+
+    $ rails g amp-html:bundle --analytics --notifications
+
+You can also run the three generators independently:
+
+    $ rails g amp-html:install
+    $ rails g amp-html:helpers
+    $ rails g amp-html:views
+
+*Each* of them supports the `--split || -s` option to use **both** regular views and AMP views.
+To add components, you need to pass them as option to each generator.
+
+### Test and validate AMP
+
+AmpHtml allows you to test and validate your views out of the box:
+
+    $ amp-html test all
+
+Pass `--split` as an option if you are using SplitView:
+
+    $ amp-html test all --split
+
+`test all` runs multiple tests to check if your code is valid. You can also run each test specifically.
+
+To get a list of all tests and learn how to run them, go to [how to test and validate](https://github.com/slooob/amp-html/wiki/Guides:-Test-and-validate)
+
+To all tests (even `test all`) you can pass the option `--fix || -f` and AmpHtml will suggest changes you could make. You can accept or reject them.
+If you want to automatically fix the code, pass `--autofix || -af` as option. Be careful, you will not be asked to approve changes to the documents!
+
+AMP has a validator built in. To validate:
+
+    $ amp-html validate root # validates "http://localhost:3000"
+    $ amp-html validate https://slooob.com # validates "https://slooob.com"
+
+**Note:** `root` is only available as a parameter in development environment..
+
+## Usage
+
+### Helpers
+
+### SplitView
+
+## Guides
+
+## Components
+
+---
+
+## Contributors
+
+Give the people some :heart: who are working on this project. Check them all at:
+
+[https://github.com/slooob/amp-html/graphs/contributors](https://github.com/slooob/amp-html/graphs/contributors)
+
+## License
+
+MIT License
+
+Copyright (c) 2017 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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/amp-html.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path(File.join('..', 'lib', 'amp_html', 'version'), __FILE__)
+
+Gem::Specification.new do |gem|
+    gem.name                  = 'amp-html'
+    gem.version               = AmpHtml::VERSION
+    gem.platform              = Gem::Platform::RUBY
+    gem.summary               = 'Reliable and high-performant apps with AMP & Rails.'
+    gem.description           = "[BETA] AmpHtml is a universal solution to integrate the AMP Project (Accelerated Mobile Pages Project) into your Rails app with ease. It enables you to quickly spin-up, build and test your app with AMP, while fulfilling the app's unique requirements. It comes with a bunch of superpowers like user authentication, notifications, blogs, animations and support for assets in AMP. Make your app consistently fast, beautiful and high-performing across devices and distribution platforms."
+    gem.authors               = ['Jonas Hübotter']
+    gem.email                 = 'developer@slooob.com'
+    gem.homepage              = 'https://github.com/slooob/amp-html' # https://railsamp.com
+    gem.license               = 'MIT'
+
+    gem.files                 = `git ls-files`.split("\n")
+    gem.require_paths         = ['lib']
+    gem.bindir                = 'bin'
+    gem.executables           = ['amp-html']
+
+    gem.post_install_message  = IO.read('INSTALL.md')
+
+    gem.required_ruby_version = '>= 2.0'
+
+
+    gem.add_dependency 'rails', '>= 4.0.0'
+    gem.add_dependency 'thor', '~> 0.19.4'
+    gem.add_dependency 'launchy', '~> 2.4'
+    gem.add_dependency 'highline', '~> 1.7'
+end

data/bin/amp-html

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'amp-html'
+AmpHtml::Cli.start

data/lib/amp_html.rb

@@ -0,0 +1,27 @@
+begin
+    require 'rails'
+rescue Exception
+    warn 'Ensure you are in a Ruby on Rails environment'
+end
+
+module AmpHtml
+
+    require 'amp_html/root'
+    require 'amp_html/version'
+
+    require 'amp_html/cli'
+
+    require 'amp_html/configuration'
+    require 'amp_html/configuration/help'
+
+    require 'amp_html/test'
+    require 'amp_html/validate'
+
+    require 'amp_html/components/install'
+
+    require 'amp_html/helpers/help'
+    require 'amp_html/components/help'
+    require 'amp_html/test/help'
+    require 'amp_html/validate/help'
+
+end

data/lib/amp_html/cli.rb

@@ -0,0 +1,113 @@
+require 'thor'
+
+class AmpHtml::Cli < Thor
+
+    check_unknown_options!
+
+    desc 'version', 'Display currently used version'
+    map %w[--version] => :version
+
+    def version
+        puts ::AmpHtml::Version.current
+    end
+
+
+    desc 'helpers', 'Learn more about AMP-HTML view helpers'
+    map %w[--helpers] => :helpers
+
+    def helpers
+        puts ::AmpHtml::Helpers::Help.all
+    end
+
+
+    desc 'helper NAME', 'Get infomration about a specific AMP-HTML helper'
+    map %w[--helper] => :helper
+
+    def helper name
+        puts ::AmpHtml::Helpers::Help.helper name
+    end
+
+
+    desc 'configuration', 'Learn how to configure AMP-HTML'
+    map %w[--configuration] => :configuration
+
+    def configuration
+        puts ::AmpHtml::Configuration::Help.all
+    end
+
+
+    desc 'components', 'Learn more about AMP-HTML installable components'
+    map %w[--components] => :components
+
+    def components
+        puts ::AmpHtml::Components::Help.all
+    end
+
+
+    desc 'component NAME', 'Get infomration about a specific AMP-HTML installable component'
+    map %w[--component] => :component
+
+    def component name
+        puts ::AmpHtml::Components::Help.component name
+    end
+
+
+    desc 'bundle', 'Install all AMP-HTML components specified in the config/AmpHtml.yml file'
+    map %w[-b --bundle] => :bundle
+
+    def bundle
+        puts ::AmpHtml::Components::Install.bundle
+    end
+
+    desc 'install COMPONENT', 'Install a specific AMP-HTML component'
+    map %w[-b --bundle] => :install
+
+    def install component
+        puts ::AmpHtml::Components::Install.install component
+    end
+
+
+    desc 'validate URL', 'Validate a specific AMP-HTML view'
+    map %w[--validate] => :validate
+
+    option :server_running, desc: 'Passes information that the server is running (optional)', type: :boolean, default: false, aliases: '-r'
+    option :help, desc: 'Additional help information', type: :boolean, default: false, aliases: '-h'
+
+    def validate url
+        unless options[:help]
+            if options[:server_running]
+                puts ::AmpHtml::Validate.validate url, true
+            else
+                puts ::AmpHtml::Validate.validate url, false
+            end
+        else
+            puts ::AmpHtml::Validate::Help.all
+        end
+    end
+
+
+    desc 'test NAME', 'Test AMP-HTML components. Run test all to bundle tests.'
+    map %w[-t --test] => :test
+
+    option :split, desc: 'Use this option if you are using SplitView', type: :boolean, default: false, aliases: '-s'
+    # option :fix, desc: 'Suggest ways to fix errors along the way', type: :boolean, default: false, aliases: '-f'
+    # option :autofix, desc: 'Attempt to automatically fix errors (not recommended)', type: :boolean, default: false, aliases: '-af'
+    option :help, desc: 'Additional help information', type: :boolean, default: false, aliases: '-h'
+
+    def test name
+        unless options[:help]
+            if name == 'all'
+                puts ::AmpHtml::Test.all
+            elsif name == 'markup'
+                puts ::AmpHtml::Test.markup
+            elsif name == 'html'
+                puts ::AmpHtml::Test.html
+            elsif name == 'css'
+                puts ::AmpHtml::Test.css
+            end
+        else
+            puts ::AmpHtml::Test::Help.all
+        end
+    end
+
+end

data/lib/amp_html/components/docs/README.md

@@ -0,0 +1,101 @@
+
+# AMP-HTML Components
+
+
+## All Components
+
+All currently supported components for AMP-HTML. New are added continuously.
+
+### Built-in
+
+* [Media BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/media.md)
+* [Forms BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/forms.md)
+* [Schema.org](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/schema.md)
+* [Fonts BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/fonts.md)
+* [Stylesheets](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/stylesheets.md)
+* [Mustache.js](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/mustache.md)
+
+### Installable
+
+* [Advertisements BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/ad.md)
+* [Analytics BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/analytics.md)
+* [Animated Images BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/anim.md)
+* [Iframe BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/iframe.md)
+* [Notifications BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/notifications.md)
+* [Social BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/social.md)
+* [Javascript BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/javascript.md)
+* [Service Worker BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/service_worker.md)
+* [Lists BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/lists.md)
+
+
+## Installing Components
+
+AMP-HTML makes it easy to add new feature-sets with components without bloating your app right from the beginning.
+
+You can install any component by running:
+
+    amp-html install NAME
+
+So running `amp-html install analytics` will install the AMP-HTML Analytics component.
+
+You can view all currently installed components in your AMP-HTML configuration file (`config/amp-html.yml`).
+
+After editing the list of components in your configuration run:
+
+    amp-html bundle
+
+to install all added and uninstall all removed components.
+
+**Now you are ready to use your added components.**
+To learn more about the features of a specific component, take a look at their dedicated references.
+
+To update your configuration file after new components got added to AMP-HTML run:
+
+    rails g amp-html:install
+
+
+## About Components
+
+AMP-HTML components are an easy way to use AMP and Rails to build slim, performant and powerful applications. They allow to add the exact superpower or feature your app needs. You stay in control of what features your app uses and which not.
+
+### What features are components?
+
+The vanilla version of AMP-HTML comes just with everything you need to get you and your app started with AMP. To really profit from all the features that AMP-HTML provides, you need to install components. Some components like "Iframe" or "Animated Images" are considerably smaller than others like "Authentication" and "Notifications". You decide which components your app needs.
+
+### DeepIntegration Components
+
+DeepIntegration components are usually larger, more complex components, that integrate more deeply into your app. They often provide options to get configured in your AMP-HTML configuration file (`config/amp-html.yml`) and / or they require to be setup in your view. You can learn more about whether a certain component has DeepIntegration or not by looking at their dedicated references.
+
+### Availability of Components
+
+The availability of components summarizes whether a component is included in the vanilla version of AMP-HTML or if it needs to be installed in order to get used.
+
+---
+
+## New Components
+
+Take a look at the newest additions of components to AMP-HTML.
+
+* [Lists BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/lists.md)
+* [Mustache.js](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/mustache.md)
+* [Service Worker BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/service_worker.md)
+* [Forms BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/forms.md)
+* [Javascript BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/javascript.md)
+
+
+## Components in BETA
+
+Take a look at the newest additions of components to AMP-HTML.
+
+* [Forms BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/forms.md)
+* [Media BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/media.md)
+* [Fonts BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/fonts.md)
+* [Advertisements BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/ad.md)
+* [Analytics BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/analytics.md)
+* [Animated Images BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/anim.md)
+* [Iframe BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/iframe.md)
+* [Notifications BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/notifications.md)
+* [Social BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/social.md)
+* [Javascript BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/javascript.md)
+* [Service Worker BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/service_worker.md)
+* [Lists BETA](https://github.com/slooob/amp-html/blob/master/lib/amp-html/components/docs/lists.md)