middleman-versions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc29a097675e1b478a5c5dd6064b194f3e0639ff
+  data.tar.gz: cdaf29ebcbeae782eea896914007575e36768bbc
+SHA512:
+  metadata.gz: 700b08cf243e77f92c3484807eec7b593629ca77f06de26f53dc9c5edfcdf8b684fcf317c3ace38bec369645b5777f5d5a67f0a3fc19468e3f88691c673fb6bb
+  data.tar.gz: 4df9e19ba9916467ead7c512513abf23279e31c621328532842fa08a64930dc932da3e44d763d3bca0223b66ab5639e4aedd0c191f329946a41468e626a4e5b3

data/.gitignore

@@ -0,0 +1,7 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+*.gem

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-versions.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,63 @@
+#middleman-versions
+Compile different middleman site versions with custom data injected in each one
+
+## How to use it
+* Add gem to your Gemfile
+
+  ```ruby
+  gem 'middleman-versions'
+  ```
+* Install gems
+
+   ```ruby
+   bundle install
+   ```
+
+* Edit config.rb and add:
+
+  ```ruby
+  activate :versions do |foo|
+    #extension configuration params
+  end
+  ```
+
+## Extension params:
+| Param name           | Description                                                | Type                                                                                      | Default value | Mandatory |
+|----------------------|------------------------------------------------------------|-------------------------------------------------------------------------------------------|---------------|-----------|
+| versions_path        | Directory where we have our data files                     | String                                                                                    | versions/     | Not       |
+| versions             | List of files that will be treated as versions files       | Array of:  {:path => "name of file", :decorated_name => "name to be showed in interface"} | Empty         | Yes       |
+| origin_template      | Template where will be injected the data readed from files | String                                                                                    | index.html    | Not       |
+| destination_template | Name of final compiled file                                | String                                                                                    | index.html    | Not       |
+
+## Injected variables on Template
+| Variable name   | Description                         | Type          | Example                                                                                      |
+|-----------------|-------------------------------------|---------------|----------------------------------------------------------------------------------------------|
+| versions_paths  | List of all versions final paths    | Array[String] | ["v1/index.html", "v2/index.html"]                                                             |
+| versions_list   | List of all version decorated names | Array[String] | ["v1","v2"]                                                                                  |
+| version_data    | Data readed from version file       | Hash          | {"license"=>{"name"=>"Apache 2.0", "url"=>"http://www.apache.org/licenses/LICENSE-2.0.html"}} |
+| current_version | Current version of page itself      | String        | v1                                                                                           |
+| current_path    | Current final path of page itself   | String        | v1/index.html                                                                                |
+                                                         |
+## Compile to static site
+When you execute ````middleman build``` you will get a structure like this
+
+```
+build
+└─── v1
+│    │     index.html
+│
+└─── v2
+|    │    index.html
+│
+└─── resources
+          └─── fonts
+          └─── images
+          └─── javascripts
+          └─── stylesheets
+```
+
+
+## TODO:
+- [ ] Example Middleman project using this gem
+- [ ] Load all files in versions_path and use file name as decorated_name instead of set versions hash
+- [ ] Load subdirectories in versions_path as versions and merge all files inside subdirectory as the same version

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-versions')

data/fixtures/directory_with_files/v1.yml

@@ -0,0 +1,32 @@
+---
+routes:
+- url_parameters:
+    id: Esta es el id del usuario que queremos modificar
+  body:
+    mandatory_parameters:
+      username:
+        validations: Debe tener un numero por que si
+        type: String
+      password:
+        validations: Tiene que ser 1234
+        type: String
+      email:
+        validations: Debe ser de google
+        type: String
+    optional_parameters:
+      aficiones:
+        validations: Debe contener 300 caracteres como minimo
+        type: String
+  example_data:
+    username: supertomate@gmail.com
+    password: supertomate@gmail.com
+    aficiones: supertomate@gmail.com
+    email: supertomate@gmail.com
+  headers:
+    content_type: application/json
+    accept: application/json
+  method: put
+  description: Modificar un usuario
+path: "/users"
+description: Esta es la seccion dedicada a las rutas de usuario. El usuario es cada una de las personas o entes que tienen acceso a una o varias empresas.
+title: Usuario v1

data/fixtures/directory_with_files/v2.json

@@ -0,0 +1,46 @@
+{
+  "routes": [
+    {
+      "url_parameters": {
+        "id": "Esta es el id del usuario que queremos modificar"
+      },
+      "body": {
+        "mandatory_parameters": {
+          "username": {
+            "validations": "Debe tener un numero por que si",
+            "type": "String"
+          },
+          "password": {
+            "validations": "Tiene que ser 1234",
+            "type": "String"
+          },
+          "email": {
+            "validations": "Debe ser de google",
+            "type": "String"
+          }
+        },
+        "optional_parameters": {
+          "aficiones": {
+            "validations": "Debe contener 300 caracteres como minimo",
+            "type": "String"
+          }
+        }
+      },
+      "example_data": {
+        "username": "supertomate@gmail.com",
+        "password": "supertomate@gmail.com",
+        "aficiones": "supertomate@gmail.com",
+        "email": "supertomate@gmail.com"
+      },
+      "headers": {
+        "content_type": "application/json",
+        "accept": "application/json"
+      },
+      "method": "put",
+      "description": "Modificar un usuario"
+    }
+  ],
+  "path": "/users",
+  "description": "Esta es la seccion dedicada a las rutas de usuario. El usuario es cada una de las personas o entes que tienen acceso a una o varias empresas.",
+  "title": "Usuario v2"
+}

data/lib/middleman/middleman-versions.rb

@@ -0,0 +1,8 @@
+require 'middleman-core'
+
+::Middleman::Extensions.register(:versions) do
+  require_relative "versions/extension"
+  require_relative 'versions/version'
+  require_relative 'versions/helpers/file_handler'
+  ::Middleman::VersionsExtension
+end

data/lib/middleman/versions/extension.rb

@@ -0,0 +1,35 @@
+module Middleman
+  class VersionsExtension < ::Middleman::Extension
+    option :versions_path, 'versions/', 'Directory path where we search the versions'
+    option :versions, [], 'Array of hashes, {:path => "name of file", :decorated_name => "name to be showed in interface"}'
+    option :origin_template, 'index.html', 'Template where data will be inserted the data'
+    option :destination_template, 'index.html', 'Compiled template name'
+
+    def initialize(app, options_hash={}, &block)
+      super
+    end
+
+
+    def after_configuration
+      app.config[:versions_options] = options
+      versions_list = options.versions.map{|x| x[:decorated_name]}
+      versions_paths = options.versions.map{|x| x[:decorated_name] + "/" + options.destination_template}
+
+      options.versions.each do |version|
+        full_version_path = options.versions_path + version[:path]
+        version_data = Versions::FileHandler::load_file(full_version_path)
+        current_path = "#{version[:decorated_name]}/#{options.destination_template}"
+
+        app.proxy "#{current_path}", "/#{options.origin_template}",
+        :locals => {
+          :versions_paths => versions_paths,
+          :versions_list => versions_list,
+          :version_data => version_data ,
+          :current_version => version[:decorated_name],
+          :current_path => "#{current_path}"
+          },
+        :ignore => true
+      end
+    end
+  end
+end

data/lib/middleman/versions/helpers/file_handler.rb

@@ -0,0 +1,24 @@
+module Middleman
+  module Versions
+    module FileHandler
+      def self.load_file(path)
+        case File.extname(path)
+          when ".yml",".yaml"
+            load_yaml_file path
+          when ".json"
+            load_json_file path
+        end
+      end
+
+      private_class_method def self.load_yaml_file(path)
+        require 'yaml'
+        YAML::load(File.open(path))
+      end
+
+      private_class_method def self.load_json_file(path)
+        require 'json'
+        JSON.parse( IO.read(path))
+      end
+    end
+  end
+end

data/lib/middleman/versions/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Versions
+    VERSION = "0.0.1"
+  end
+end

data/lib/middleman-versions.rb

@@ -0,0 +1 @@
+require_relative 'middleman/middleman-versions'

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-versions'

data/middleman-versions.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-versions"
+  s.version     = "1.0.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Pedro Rivas", "Cuéntica","Guillermo Latorre", "David Olmos"]
+  s.email       = ["rmdrobs@gmail.com", "contacto@cuentica.com", "superwillyfoc@gmail.com", "olmos.david@gmail.com"]
+  s.homepage    = "https://github.com/cuentica/middleman-versions.git"
+  s.summary     = %q{Compile different middleman versions with custom data injected in each one}
+  s.description = %q{Compile different middleman versions with custom data injected in each one}
+
+  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"]
+
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 4.0.0"])
+
+  # Additional dependencies
+  # s.add_runtime_dependency("gem-name", "gem-version")
+end

data/spec/file_handler_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+require_relative '../lib/middleman/versions/helpers/file_handler'
+
+describe "FileHandler" do
+  it "load_file method must return a non empty hash from json file" do
+    version_hash = Middleman::Versions::FileHandler::load_file(File.join(File.dirname(__FILE__),"../fixtures/directory_with_files/v2.json"))
+    expect(version_hash).to include({"title" => "Usuario v2"})
+  end
+  it "load_file method must return a non empty hash from yml file" do
+    version_hash = Middleman::Versions::FileHandler::load_file(File.join(File.dirname(__FILE__),"../fixtures/directory_with_files/v1.yml"))
+    expect(version_hash).to include({"title" => "Usuario v1"})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: middleman-versions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pedro Rivas
+- Cuéntica
+- Guillermo Latorre
+- David Olmos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Compile different middleman versions with custom data injected in each
+  one
+email:
+- rmdrobs@gmail.com
+- contacto@cuentica.com
+- superwillyfoc@gmail.com
+- olmos.david@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- features/support/env.rb
+- fixtures/directory_with_files/v1.yml
+- fixtures/directory_with_files/v2.json
+- lib/middleman-versions.rb
+- lib/middleman/middleman-versions.rb
+- lib/middleman/versions/extension.rb
+- lib/middleman/versions/helpers/file_handler.rb
+- lib/middleman/versions/version.rb
+- lib/middleman_extension.rb
+- middleman-versions.gemspec
+- spec/file_handler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cuentica/middleman-versions.git
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Compile different middleman versions with custom data injected in each one
+test_files: []