data_processor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5d3e4b459833af7ae7a6fae536aed4e0fe7c0bf
+  data.tar.gz: 16eebb950572912b767e7d81560642568add98da
+SHA512:
+  metadata.gz: 42727dbc3633d50c8e5f2fe21e2b76d20426a76c9b88b25fa07a0afbf452cb01505c536d57e3edc36a4ba29206f01657b88c79c245efc5d25086e8e8d02a0f6f
+  data.tar.gz: 3d6d00e5015020c34a8add41c3801cda92349d265a2b4647d79d180ab39f5e2b0f2ded48561bb2bc7b50c7444c896cd3dfe889798e24bf9baea4c81e1a39c404

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in data_processor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Steven Vandevelde
+
+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,86 @@
+# Data Processor
+
+Parse YAML and Markdown files, manipulate their data and convert it to JSON.
+
+
+
+## Dependencies
+
+- Redcarpet
+- Oj
+
+
+
+## How it works
+
+_File structure:_
+
+```
+/example_path/en/base.yaml
+/example_path/en/pages/index.yaml
+/example_path/en/pages/index.md
+```
+
+_JSON Output: (by using the code below)_
+
+```json
+{
+  "en": {
+    "is_directory": true,
+    "locale": "en",
+    
+    "base": {
+      "value_from_base_yaml": "1"
+    },
+    
+    "pages": {
+      "is_directory": true,
+      
+      "index": {
+        "title": "Homepage Title",
+        "slug": "homepage-title",
+        
+        "parsed_markdown": "<p>Parsed markdown from index.md</p>",
+        
+        "is_yaml": true,
+        "is_markdown": true
+      }
+    }
+  }
+}
+```
+
+_Ruby Hash:_
+
+Pretty much the same as the JSON output, strings as keys, not symbols.
+
+
+
+## Usage
+
+```ruby
+# New instance
+# -> takes path as first argument, default is current directory
+d = DataProcessor.new("/")
+
+# Import data
+# -> takes path as first argument, default is initial directory
+d.import("example_path/")
+
+# Manipulate data
+# -> 1st arg, the path without file extension (string)
+# -> 2nd arg, override, obj will be set to the return value of the block (boolean, optional)
+# -> block to execute manipulations in
+d.manipulate("en") { |obj| obj["locale"] = "en" }
+d.manipulate("en/pages/index") { |obj| obj["slug"] = obj["title"].to_slug }
+
+# Output
+d.get_data # ruby hash
+d.output_json # json
+```
+
+
+
+## Markdown
+
+Redcarpet is used here to parse markdown. You can override the markdown renderer by overriding `DataProcessor::markdown_renderer`, which returns a renderer.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/data_processor.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "data_processor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_processor"
+  spec.version       = DataProcessor::VERSION
+  spec.authors       = ["Steven Vandevelde"]
+  spec.email         = ["icid.asset@gmail.com"]
+  spec.summary       = %q{Parse YAML and Markdown files, manipulate their data and convert it to JSON}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "redcarpet", "~> 3.1.2"
+  spec.add_runtime_dependency "oj", "~> 2.10.2"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/data_processor/getters.rb

@@ -0,0 +1,9 @@
+class DataProcessor
+  module Getters
+
+    def get_data
+      @data
+    end
+
+  end
+end

data/lib/data_processor/import.rb

@@ -0,0 +1,47 @@
+class DataProcessor
+  module Import
+
+    def import(path="", data_obj=nil)
+      path = path.sub(/^\//, "")
+
+      data_hash = data_obj || @data
+      full_path = @initial_path + path
+
+      Dir.foreach(full_path) do |filename|
+        next if filename[0] == "."
+        combined_path = File.join(full_path, filename)
+
+        # directory
+        if File.directory?(combined_path)
+          data_hash[filename] ||= {}
+          data_hash[filename].merge!(import(File.join(path, filename), data_hash[filename]))
+          data_hash[filename].merge!({ "is_directory" => true })
+
+        # yaml file
+        elsif filename.end_with?(".yml")
+          without_ext = File.basename(filename, ".yml")
+          yaml_data = YAML.load_file(combined_path) || {}
+
+          data_hash[without_ext] ||= {}
+          data_hash[without_ext].merge!(yaml_data)
+          data_hash[without_ext].merge!({ "is_yaml" => true })
+
+        # markdown file
+        elsif filename.end_with?(".md")
+          without_ext = File.basename(filename, ".md")
+          file = File.open(combined_path, "r")
+          parsed_markdown = self.parse_markdown(file.read)
+          file.close
+
+          data_hash[without_ext] ||= {}
+          data_hash[without_ext].merge!({ "parsed_markdown" => parsed_markdown })
+          data_hash[without_ext].merge!({ "is_markdown" => true })
+
+        end
+      end
+
+      data_hash
+    end
+
+  end
+end

data/lib/data_processor/manipulate.rb

@@ -0,0 +1,37 @@
+class DataProcessor
+  module Manipulate
+
+    def manipulate(path, override=false)
+      obj = @data
+      parent_obj = nil
+
+      if block_given?
+        counter = 0
+        path_split = path.split("/")
+
+        # down the rabbit hole
+        path_split.each do |p|
+          if obj && obj[p]
+            parent_obj = obj
+            obj = obj[p]
+            counter = counter + 1
+          else
+            parent_obj = nil
+            obj = nil
+          end
+        end
+
+        # execute block with object as param
+        # ie. if the object is found
+        # + override object with return value of block if needed
+        if obj && (counter == path_split.length)
+          return_value = yield(obj, parent_obj)
+          parent_obj[path_split.last] = return_value if override
+        end
+      end
+
+      obj
+    end
+
+  end
+end

data/lib/data_processor/output.rb

@@ -0,0 +1,9 @@
+class DataProcessor
+  module Output
+
+    def output_json
+      Oj.dump(@data)
+    end
+
+  end
+end

data/lib/data_processor/version.rb

@@ -0,0 +1,3 @@
+class DataProcessor
+  VERSION = "0.1.0"
+end

data/lib/data_processor.rb

@@ -0,0 +1,49 @@
+require "yaml"
+require "redcarpet"
+require "oj"
+
+require "data_processor/getters"
+require "data_processor/import"
+require "data_processor/manipulate"
+require "data_processor/output"
+
+class DataProcessor
+  include DataProcessor::Getters
+  include DataProcessor::Import
+  include DataProcessor::Manipulate
+  include DataProcessor::Output
+
+  def initialize(initial_path="./")
+    @data = {}
+    @initial_path = initial_path
+
+    create_markdown_parser
+  end
+
+
+  #
+  #  Markdown
+  #
+  def self.markdown_renderer
+    Redcarpet::Render::HTML
+  end
+
+
+  def create_markdown_parser
+    @markdown_parser = Redcarpet::Markdown.new(
+      DataProcessor::markdown_renderer,
+      fenced_code_blocks: true,
+      strikethrough: true,
+      superscript: true,
+      underline: true,
+      highlight: true,
+      smartypants: true
+    )
+  end
+
+
+  def parse_markdown(string)
+    @markdown_parser.render(string)
+  end
+
+end

data/test/fixtures/data/en/base.yml

@@ -0,0 +1 @@
+value_from_base: "1"

data/test/fixtures/data/en/pages/index.md

@@ -0,0 +1 @@
+Parsed markdown from index.md

data/test/fixtures/data/en/pages/index.yml

@@ -0,0 +1 @@
+value_from_index_yaml: "1"

data/test/test.rb

@@ -0,0 +1,76 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "minitest/autorun"
+require "data_processor"
+
+class TestDataProcessor < MiniTest::Unit::TestCase
+
+  def setup
+    @d = ::DataProcessor.new("./test/fixtures/")
+  end
+
+
+  def test_initial_data_object
+    assert_kind_of Hash, @d.get_data
+  end
+
+
+  def test_import
+    @d.import("data/")
+    data = @d.get_data
+
+    assert_kind_of Hash, data["en"]
+    assert_kind_of Hash, data["en"]["base"]
+    assert_kind_of Hash, data["en"]["pages"]
+    assert_kind_of Hash, data["en"]["pages"]["index"]
+
+    assert_equal(
+      "<p>Parsed markdown from index.md</p>\n",
+      data["en"]["pages"]["index"]["parsed_markdown"]
+    )
+
+    assert_equal(
+      "1",
+      data["en"]["pages"]["index"]["value_from_index_yaml"]
+    )
+  end
+
+
+  def test_manipulate
+    @d.import("data/")
+
+    # manipulate
+    @d.manipulate("en") { |obj| obj["locale"] = "en" }
+    @d.manipulate("en/pages", true) { |obj| obj.to_a }
+
+    # get data
+    data = @d.get_data
+
+    # assertions
+    assert_equal(
+      "en",
+      data["en"]["locale"]
+    )
+
+    assert_kind_of(
+      Array,
+      data["en"]["pages"]
+    )
+  end
+
+
+  def test_output
+    @d.import("data/")
+
+    # data
+    data = @d.get_data
+    parsed_json = Oj.load(@d.output_json)
+
+    # assertions
+    assert_equal(
+      parsed_json["en"]["pages"]["index"]["value_from_index_yaml"],
+      data["en"]["pages"]["index"]["value_from_index_yaml"]
+    )
+  end
+
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: data_processor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steven Vandevelde
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parse YAML and Markdown files, manipulate their data and convert it to
+  JSON
+email:
+- icid.asset@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- data_processor.gemspec
+- lib/data_processor.rb
+- lib/data_processor/getters.rb
+- lib/data_processor/import.rb
+- lib/data_processor/manipulate.rb
+- lib/data_processor/output.rb
+- lib/data_processor/version.rb
+- test/fixtures/data/en/base.yml
+- test/fixtures/data/en/pages/index.md
+- test/fixtures/data/en/pages/index.yml
+- test/test.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Parse YAML and Markdown files, manipulate their data and convert it to JSON
+test_files:
+- test/fixtures/data/en/base.yml
+- test/fixtures/data/en/pages/index.md
+- test/fixtures/data/en/pages/index.yml
+- test/test.rb