chintz 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f10332ed897cbdaebc9a63fb143b03e7a7a1b7a9
+  data.tar.gz: bbf343435d5a1da03494c49fa61efe0a30038e98
+SHA512:
+  metadata.gz: a9716ecab16e06f2f237586ea60f197d6115055c16bc599b2daaf83404995dc571fbaebfffcbdb2956aacd975bde073080ef53650487549729f74092ed742b6f
+  data.tar.gz: 125c704a695583b41eb9a42e0e638ec8c014f065097e889fd83a7eff21c516deaf64b7d37d0d5f49181478920aec924cdebfa28220bf0328ece96b60bbcac363

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+chintz-*.gem

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,2 @@
+# chintz-ruby
+Ruby implementation of BBC News Chintz

data/chintz.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'chintz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chintz'
+  spec.version       = Chintz::VERSION
+  spec.authors       = ['John Clevely', 'Joseph Wynn']
+  spec.email         = ['john.clevely@bbc.co.uk', 'joseph.wynn@bbc.co.uk']
+  spec.summary       = 'Responsive images for Jekyll via srcset'
+  spec.homepage      = 'https://github.com/BBC-News/chintz-ruby'
+  spec.licenses      = ['Apache-2.0']
+  spec.description   = %q{
+    Ruby implementation of the BBC News Chintz specification
+  }
+
+  spec.files        = `git ls-files`.split($/)
+  spec.test_files   = `git ls-files -- spec/*`.split("\n")
+  spec.executables  = []
+  spec.require_path = 'lib'
+
+  spec.add_runtime_dependency 'mustache', ['>= 1.0', '< 2.0']
+end

data/lib/chintz/fixture.rb

@@ -0,0 +1,13 @@
+require 'yaml'
+
+module Chintz
+  class Fixture
+    def initialize(base_path)
+      @base_path = base_path
+    end
+
+    def load_plain_yaml(name)
+      YAML.load_file("#{@base_path}/fixtures/#{name}.yaml")
+    end
+  end
+end

data/lib/chintz/mustache.rb

@@ -0,0 +1,17 @@
+require 'mustache'
+require 'chintz/path'
+
+module Chintz
+  class Mustache < ::Mustache
+    def partial(name)
+      path = Path.resolve(template_path, name, template_extension)
+
+      begin
+        File.read(path)
+      rescue
+        raise if raise_on_context_miss?
+        ""
+      end
+    end
+  end
+end

data/lib/chintz/parser.rb

@@ -0,0 +1,66 @@
+require 'yaml'
+require 'chintz/mustache'
+require 'chintz/path'
+
+module Chintz
+  class Parser
+
+    def initialize(base_path, renderer = nil)
+      @base_path = base_path
+      @deps = {}
+
+      @renderer ||= Chintz::Mustache
+      @renderer.template_path = base_path
+    end
+
+    def prepare(element_names)
+      element_names = [element_names] unless element_names.kind_of?(Array)
+      element_names.each do |element_name|
+        raise ArgumentError, 'String or Array of strings' unless element_name.kind_of? String
+        element = load_yaml element_name
+        raise NameError, 'Manifest must provide a Name' unless element['name']
+        return unless element['dependencies']
+        resolve_dependencies element['dependencies']
+      end
+      @deps
+    end
+
+    def load_yaml(name)
+      yaml_path = Path.resolve(@base_path, name, 'yaml')
+
+      raise NameError, "Manifest file for #{name} not found in #{@base_path}" if yaml_path.nil?
+
+      YAML.load_file yaml_path
+    end
+
+    def resolve_dependencies(deps)
+      deps.each do |type, value|
+        unless type == 'elements'
+          add_dependency type, value
+        end
+        if type == 'elements'
+          value.each do |child_element|
+            prepare child_element #recursive
+          end
+        end
+      end
+    end
+
+    def add_dependency(type, value)
+      @deps[type] ||= []
+      @deps[type].concat value
+    end
+
+    def dependency(type)
+      @deps[type]
+    end
+
+    def render(element, data = nil)
+      unless data
+        data = fixture()
+      end
+      @renderer.render_file(element, data)
+    end
+
+  end
+end

data/lib/chintz/path.rb

@@ -0,0 +1,7 @@
+module Chintz
+  class Path
+    def self.resolve(base_path, name, extension)
+      Dir.glob("#{base_path}/*/#{name}/#{name}.#{extension}").first
+    end
+  end
+end

data/lib/chintz/version.rb

@@ -0,0 +1,3 @@
+module Chintz
+  VERSION = '0.1.1'.freeze
+end

data/spec/fixtures/organism/robin/robin.yaml

@@ -0,0 +1,3 @@
+name: robin
+dependencies:
+  css: [path/to/robin.css]

data/spec/parser_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'chintz/parser'
+
+describe 'Chintz Parser' do
+  before(:each) do
+    @parser = Chintz::Parser.new(File.expand_path('../fixtures', __FILE__))
+  end
+
+  it 'should raise error if prepare arg is not a string or array of strings' do
+    expect {@parser.prepare({})}.to raise_error(ArgumentError)
+  end
+
+  it 'should raise error if name is not defined' do
+    allow(YAML).to receive(:load_file).and_return({})
+    expect {@parser.prepare('foo')}.to raise_error(NameError)
+  end
+
+  it 'should return dependencies' do
+    expect(@parser.prepare('robin')).to eq({'css' => ['path/to/robin.css']})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  config.color = true
+  config.order = "random"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: chintz
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- John Clevely
+- Joseph Wynn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: "\n    Ruby implementation of the BBC News Chintz specification\n  "
+email:
+- john.clevely@bbc.co.uk
+- joseph.wynn@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- chintz.gemspec
+- lib/chintz/fixture.rb
+- lib/chintz/mustache.rb
+- lib/chintz/parser.rb
+- lib/chintz/path.rb
+- lib/chintz/version.rb
+- spec/fixtures/organism/robin/robin.yaml
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/BBC-News/chintz-ruby
+licenses:
+- Apache-2.0
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Responsive images for Jekyll via srcset
+test_files:
+- spec/fixtures/organism/robin/robin.yaml
+- spec/parser_spec.rb
+- spec/spec_helper.rb