protopack 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4962b6fe26ba640ce33336d3b1bd7ad184a0f93
-  data.tar.gz: 1467ff0a3ebd69e37afa24e33a549a314cc99281
+  metadata.gz: 78a62b7195e16bf1e652f062893e09fa386c3cdd
+  data.tar.gz: 387c89d2bd400de745cd6c740f5527c7db73845f
 SHA512:
-  metadata.gz: 9f4b436397759f4030003908029f139d7144c17d9c5c638ad4eff2a66d2a2e44fc0354051e5a6b347dc44ed7909a8a9af98e51b55a413f5a93e202cc658b68fe
-  data.tar.gz: 76d95056304509e260ee86e59f5a043ccf93ba275e96d45a296c18a32251248f98c2deae88a06c09b1eb438301680b07c88679f5b22f56a51d5aa05c187adeb7
+  metadata.gz: 22c529ff5dda2505ec3dc2da67de63d0a3786c1542f69ffb6897628cf116785130759e447a8eccb62bed1a7d13101ba68a26e1c2062278ee74c80638720e80d0
+  data.tar.gz: 30411c3d7f5e79b69330bfc4271cb9113d32450feefc494fcd29f6cf31528f9ab188afd233b15ef2cc2ddc45cd99d141a724b735c2a2c34c338ccb067eb411bd

data/lib/protopack.rb

@@ -3,7 +3,7 @@ require "hashie"
 require "protopack/version"
 require "protopack/package"
 require "protopack/package_item"
+require "protopack/styled_yaml"
+require "protopack/exporter"
 
-module Protopack
-  # Your code goes here...
-end
+module Protopack ; end

data/lib/protopack/exporter.rb

@@ -0,0 +1,40 @@
+module Protopack
+  class Exporter
+    def maybe_name_methods    ; %i{ export_name full_name presentation_name name }                         ; end
+    def name_method obj       ; maybe_name_methods.detect { |m| obj.respond_to?(m) && obj.send(m) }        ; end
+    def array_assoc list      ; list.map { |item| to_attributes item }                                     ; end
+    def clean_yaml hsh        ; StyledYAML.dump(clean_attrs hsh)                                           ; end
+    def no_name? obj_id       ; raise "no name for object: #{obj_id.inspect}" if obj_id.blank?             ; end
+    def default_export_config ; { fields: [], associations: [] }                                           ; end
+    def export_config     obj ; default_export_config.merge obj.protopack_export_config                    ; end
+    def to_attributes     obj ; obj.slice(*export_config(obj)[:fields]).merge build_association_table obj  ; end
+    def to_yaml  obj, meta={} ; clean_yaml to_package obj, meta                                            ; end
+    def remove_blanks   attrs ; attrs.recursively_remove_by_value! { |v| (v != false) && v.blank? }        ; end
+    def styled_literal    str ; str.is_a?(String) ? StyledYAML.literal(str) : str                          ; end
+    def clean_attrs     attrs ; remove_blanks(attrs).recursively_replace_values { |k,v| styled_literal v } ; end
+
+    def build_association_table obj
+      export_config(obj)[:associations].inject({ }) { |table, name|
+        assoc = obj.send name
+        next table if assoc.blank? || assoc.empty?
+        attrs = (assoc.respond_to?(:each)) ? array_assoc(assoc) : to_attributes(assoc)
+        table["#{name}_attributes"] = attrs
+        table
+      }
+    end
+
+    def to_package obj, meta={ }
+      obj_name        = obj.send(name_method obj)
+      obj_id          = obj_name.to_s.gsub(/_/, '-')
+
+      no_name? obj_id
+
+      hsh = {
+        id:          obj_id,
+        description: obj_name,
+        type:        obj.class.name,
+        attributes:  to_attributes(obj),
+      }.deep_merge(meta).recursively_stringify_keys!
+    end
+  end
+end

data/lib/protopack/package.rb

@@ -10,9 +10,7 @@ class Protopack::Package
   end
 
   def items
-    config.items.map { |item_file|
-      Protopack::PackageItem.new(Hashie::Mash.new(YAML.load(File.read(item_file))))
-    }
+    config.items.map { |item_file| Protopack::PackageItem.load(item_file) }
   end
 
   def item id

data/lib/protopack/package_item.rb

@@ -40,4 +40,9 @@ class Protopack::PackageItem
     end
   end
 
+  def self.load filename
+    Protopack::PackageItem.new(Hashie::Mash.new(YAML.load(File.read(filename))))
+  rescue
+    raise "error reading from file #{filename}"
+  end
 end

data/lib/protopack/styled_yaml.rb

@@ -0,0 +1,124 @@
+require 'psych'
+require 'stringio'
+
+# Public: A Psych extension to enable choosing output styles for specific
+# objects.
+#
+# Thanks to Tenderlove for help in <http://stackoverflow.com/q/9640277/11687>
+#
+# Gist: https://gist.github.com/mislav/2023978
+#
+# Examples
+#
+#   data = {
+#     response: { body: StyledYAML.literal(json_string), status: 200 },
+#     person: StyledYAML.inline({ 'name' => 'Stevie', 'age' => 12 }),
+#     array: StyledYAML.inline(%w[ apples bananas oranges ])
+#   }
+#
+#   StyledYAML.dump data, $stdout
+#
+module Protopack::StyledYAML
+  # Tag strings to be output using literal style
+  def self.literal obj
+    obj.extend LiteralScalar
+    return obj
+  end
+
+  # http://www.yaml.org/spec/1.2/spec.html#id2795688
+  module LiteralScalar
+    def yaml_style() Psych::Nodes::Scalar::LITERAL end
+  end
+
+  # Tag Hashes or Arrays to be output all on one line
+  def self.inline obj
+    case obj
+    when Hash  then obj.extend FlowMapping
+    when Array then obj.extend FlowSequence
+    else
+      warn "#{self}: unrecognized type to inline (#{obj.class.name})"
+    end
+    return obj
+  end
+
+  # http://www.yaml.org/spec/1.2/spec.html#id2790832
+  module FlowMapping
+    def yaml_style() Psych::Nodes::Mapping::FLOW end
+  end
+
+  # http://www.yaml.org/spec/1.2/spec.html#id2790320
+  module FlowSequence
+    def yaml_style() Psych::Nodes::Sequence::FLOW end
+  end
+
+  # Custom tree builder class to recognize scalars tagged with `yaml_style`
+  class TreeBuilder < Psych::TreeBuilder
+    attr_writer :next_sequence_or_mapping_style
+
+    def initialize(*args)
+      super
+      @next_sequence_or_mapping_style = nil
+    end
+
+    def next_sequence_or_mapping_style default_style
+      style = @next_sequence_or_mapping_style || default_style
+      @next_sequence_or_mapping_style = nil
+      style
+    end
+
+    def scalar value, anchor, tag, plain, quoted, style
+      if style_any?(style) and value.respond_to?(:yaml_style) and style = value.yaml_style
+        if style_literal? style
+          plain = false
+          quoted = true
+        end
+      end
+      super
+    end
+
+    def style_any?(style) Psych::Nodes::Scalar::ANY == style end
+
+    def style_literal?(style) Psych::Nodes::Scalar::LITERAL == style end
+
+    %w[sequence mapping].each do |type|
+      class_eval <<-RUBY
+        def start_#{type}(anchor, tag, implicit, style)
+          style = next_sequence_or_mapping_style(style)
+          super
+        end
+      RUBY
+    end
+  end
+
+  # Custom tree class to handle Hashes and Arrays tagged with `yaml_style`
+  class YAMLTree < Psych::Visitors::YAMLTree
+    %w[String Hash Array Psych_Set Psych_Omap].each do |klass|
+      class_eval <<-RUBY
+        def visit_#{klass} o
+          if o.respond_to? :yaml_style
+            @emitter.next_sequence_or_mapping_style = o.yaml_style
+          end
+          super
+        end
+      RUBY
+    end
+  end
+
+  # A Psych.dump alternative that uses the custom TreeBuilder
+  def self.dump obj, io = nil, options = {}
+    real_io = io || StringIO.new(''.encode('utf-8'))
+    visitor = YAMLTree.new(options, TreeBuilder.new)
+    visitor << obj
+    ast = visitor.tree
+
+    begin
+      ast.yaml real_io
+    rescue
+      # The `yaml` method was introduced in later versions, so fall back to
+      # constructing a visitor
+      Psych::Visitors::Emitter.new(real_io).accept ast
+    end
+
+    io ? io : real_io.string
+  end
+end

data/lib/protopack/version.rb

@@ -1,3 +1,3 @@
 module Protopack
-  VERSION = "0.0.7"
+  VERSION = "0.0.9"
 end

data/protopack.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/conanite/protopack"
 
   gem.add_dependency             'hashie'
-  gem.add_development_dependency 'rspec', '~> 2.9'
+  gem.add_dependency             'aduki', '~> 0.2.6', '>= 0.2.6'
+  gem.add_development_dependency 'rspec'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/protopack/package_spec.rb

@@ -11,29 +11,29 @@ describe Protopack::Package do
   }
 
   it "should find all the packages" do
-    Protopack::Package.all.map(&:name).join(" ").should == "advanced-widgets standard-widgets"
+    expect(Protopack::Package.all.map(&:name).join(" ")).to eq "advanced-widgets standard-widgets"
   end
 
   it "should find a given package" do
     p = Protopack::Package.find("standard-widgets")
-    p.name.should == "standard-widgets"
+    expect(p.name).to eq "standard-widgets"
 
-    p.title.en.should == "Standard Widgets"
-    p.title.fr.should == "Widgets standards"
+    expect(p.title.en).to eq "Standard Widgets"
+    expect(p.title.fr).to eq "Widgets standards"
 
-    p.description.en.should == "Use these widgets for everyday widgeting"
-    p.description.fr.should == "Ces widgets sont utilisables pour votre widgeting quotidien"
+    expect(p.description.en).to eq "Use these widgets for everyday widgeting"
+    expect(p.description.fr).to eq "Ces widgets sont utilisables pour votre widgeting quotidien"
 
-    p.authors.should == %w{ baz titi Z }
+    expect(p.authors).to eq %w{ baz titi Z }
 
-    p.updated.should == Date.parse("2013-03-15")
+    expect(p.updated).to eq Date.parse("2013-03-15")
   end
 
   it "should install all items from a package" do
     p = Protopack::Package.find("standard-widgets")
     p.apply_all
 
-    Widget.all.map(&:colour).should == %w{ red blue yellow green black }
+    expect(Widget.all.map(&:colour)).to eq %w{ red blue yellow black green }
   end
 
   it "should install all items from a package, overwriting existing items, respecting #ordinal property" do
@@ -43,12 +43,12 @@ describe Protopack::Package do
     p = Protopack::Package.find("standard-widgets")
     p.apply_all
 
-    Widget.all.map(&:colour).should == %w{ blue green red yellow black }
-    Widget.all[0].height.should == 'elephant'
-    Widget.all[1].height.should == 'zebra'
-    Widget.all[2].height.should == 'tiger'
-    Widget.all[3].height.should == 'hyena'
-    Widget.all[4].height.should == 'camel'
+    expect(Widget.all.map(&:colour)).to eq %w{ blue green red yellow black }
+    expect(Widget.all[0].height).to eq 'elephant'
+    expect(Widget.all[1].height).to eq 'zebra'
+    expect(Widget.all[2].height).to eq 'tiger'
+    expect(Widget.all[3].height).to eq 'hyena'
+    expect(Widget.all[4].height).to eq 'camel'
   end
 
   it "should install all items from a package subject to filtering" do
@@ -57,10 +57,10 @@ describe Protopack::Package do
 
     Protopack::Package.find("standard-widgets").apply_all { |x| x.region == "Africa" }
 
-    Widget.all.map(&:colour).should == %w{ blue green yellow }
-    Widget.all[0].height.should == 'elephant'
-    Widget.all[1].height.should == 'zebra'
-    Widget.all[2].height.should == 'hyena'
+    expect(Widget.all.map(&:colour)).to eq %w{ blue green yellow }
+    expect(Widget.all[0].height).to eq 'elephant'
+    expect(Widget.all[1].height).to eq 'zebra'
+    expect(Widget.all[2].height).to eq 'hyena'
   end
 
   it "should install only missing items from a package, not overwriting existing items" do
@@ -70,18 +70,18 @@ describe Protopack::Package do
     p = Protopack::Package.find("standard-widgets")
     p.apply_missing
 
-    Widget.all.map(&:colour).should == %w{ blue green red yellow black}
-    Widget.all[0].height.should == "not specified"
-    Widget.all[1].height.should == "not specified"
-    Widget.all[2].height.should == 'tiger'
-    Widget.all[3].height.should == 'hyena'
-    Widget.all[4].height.should == 'camel'
+    expect(Widget.all.map(&:colour)).to eq %w{ blue green red yellow black}
+    expect(Widget.all[0].height).to eq "not specified"
+    expect(Widget.all[1].height).to eq "not specified"
+    expect(Widget.all[2].height).to eq 'tiger'
+    expect(Widget.all[3].height).to eq 'hyena'
+    expect(Widget.all[4].height).to eq 'camel'
   end
 
   it "looks up namespaced class names" do
     p = Protopack::Package.find("advanced-widgets")
     p.apply_missing
 
-    Wot::Zit.all.map(&:colour).sort.should == %w{ lavender magenta }
+    expect(Wot::Zit.all.map(&:colour).sort).to eq %w{ lavender magenta }
   end
 end

data/spec/spec_helper.rb

@@ -12,7 +12,7 @@ require File.expand_path('../../lib/protopack', __FILE__)
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
@@ -24,4 +24,3 @@ RSpec.configure do |config|
 end
 
 load(File.dirname(__FILE__) + '/models.rb')
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protopack
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Conan Dalton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -25,19 +25,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: aduki
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
-  type: :development
+        version: 0.2.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: 0.2.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: " Create objects from object definitions stored as files, like test fixtures,
   only intended for production use. "
 email:
@@ -53,8 +73,10 @@ files:
 - README.md
 - Rakefile
 - lib/protopack.rb
+- lib/protopack/exporter.rb
 - lib/protopack/package.rb
 - lib/protopack/package_item.rb
+- lib/protopack/styled_yaml.rb
 - lib/protopack/version.rb
 - protopack.gemspec
 - spec/models.rb
@@ -89,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Store packages of object prototypes on-disk as YML; this gem allows you scan