protopack 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.#*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 conanite
+
+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,127 @@
+# Protopack
+
+Protopack knows how to load object definitions (prototypes) from packages of yml files and apply
+them to your object repository. It's built to work seamslessly with ActiveRecord but doesn't depend
+on any component of Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'protopack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install protopack
+
+## Usage
+
+Store package items in a directory structure such as this:
+
+    config
+    |- packages
+       |- this-package
+       |  |- package-config.yml
+       |  |- this-first-item.yml
+       |  |- this-second-item.yml
+       |  |- this-third-item.yml
+       |- that-package
+          |- package-config.yml
+          |- that-first-item.yml
+          |- that-second-item.yml
+          |- that-third-item.yml
+
+Each "item" file stores attributes of the prototypes you want to be able to create.
+
+Protopack::Package distinguishes between items that already exist, and items that are missing.
+
+In order to add only missing items to your repository, call
+
+    package.apply_missing
+
+In order to apply all package items, overwriting existing items in your repository and adding any
+missing items, call
+
+    package.apply_all
+
+Protopack expects your models to implement a class method #existence to provide the interface for
+querying and creating objects. The expected interface is the same as that returned by Rails'
+ActiveRelation, so it works seamlessly with ActiveRecord.
+
+    exists = YourModel.existence(attributes)
+
+    exists.empty? # => boolean
+
+    exists.create!(attributes)  # => create an instance using the given attributes
+
+    exists.first.update_attributes(attributes)  # => overwrite attributes of an existing instance
+
+
+### package-config.yml
+
+Each package requires a package-config.yml file, with at least a "name" key. You can add whatever
+other keys you like that may be useful to your application for selecting and presenting packages.
+
+Example package-config.yml:
+
+    ---
+    name: my-widget-package
+    title:
+      en: A sample package of prototypes
+      fr: Un package exemplaire plain de prototypes
+    description:
+      en: Widgets to set up the widgeting process. Remember to enscarfle the widget feature if you install this package.
+      fr: Machins pour initialiser le processus de machination. Une fois installé, il faut impérativement enscarfler la case machinations.
+    prerequisites:
+      - my-other-package
+    updated: 2013-03-15
+
+
+### Item files
+
+Protopack::Package looks for item files in the same directory as the package-config.yml file. Item
+file names must match the glob pattern "*item*.yml". This pattern allows you give locale-specific
+names to items, if l10n is a concern: "widget-item.fr.yml", for example.
+
+Each *-item.yml contains at least three keys: "id", "type" and "attributes". Protopack calls #constantize
+on the "type" value in order to get a reference to the target class. The "attributes" are then
+passed to your #existence method as described above.
+
+You can add other keys that you might find useful for selecting and presenting items, for example, a
+"locale" key to show only items in the current user's locale.
+
+Protopack does no pre- or post-processing. Instead, define attributes on your models that will know
+what to do, perhaps in conjunction with a :before_save or :after_save handler.
+
+Example item file:
+
+    ---
+    id:              example-widget
+    description:     "This is a kind of widget that's good for widgeting"
+    locale:          en
+    type:            PublicWidget
+    attributes:
+      name:             good-widget
+      lang:             en
+      size:             42
+      next-widget-name: better-widget
+      permissions:      widget-admin, widget-user
+
+
+
+## Security
+
+Packages are executable code. Don't let end-users provide packages or package items. Protopack allows
+package authors call any method on any class.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/protopack/package.rb

@@ -0,0 +1,59 @@
+class Protopack::Package
+  attr_reader :config
+
+  def method_missing m, *args
+    config.send m, *args
+  end
+
+  def initialize cfg
+    @config = (cfg.is_a?(Hashie::Mash) ? cfg : Hashie::Mash.new(cfg))
+  end
+
+  def items
+    config.items.map { |item_file|
+      Protopack::PackageItem.new(Hashie::Mash.new(YAML.load(File.read(item_file))))
+    }
+  end
+
+  def item id
+    items.each do |item|
+      return item if (item.id == id)
+    end
+  end
+
+  def apply_missing
+    items.each do |item|
+      item.apply! if item.missing?
+    end
+  end
+
+  def apply_all
+    items.each &:apply!
+  end
+
+  def self.config_root= root
+    @@config_root = root
+  end
+
+  def self.config_root
+    @@config_root
+  end
+
+  def self.all
+    Dir.glob("#{config_root}/*/package-config.yml").map { |pkg_cfg|
+      cfg = Hashie::Mash.new(YAML.load(File.read(pkg_cfg)))
+      root = File.dirname pkg_cfg
+      cfg["items"] = Dir.glob("#{root}/*item*.yml")
+      cfg["root"] = root
+      new cfg
+    }
+  end
+
+  def self.find name
+    root = "#{config_root}/#{name}"
+    cfg = Hashie::Mash.new(YAML.load(File.read("#{root}/package-config.yml")))
+    cfg["items"] = Dir.glob("#{root}/*item*.yml")
+    cfg["root"] = root
+    new cfg
+  end
+end

data/lib/protopack/package_item.rb

@@ -0,0 +1,37 @@
+class Protopack::PackageItem
+  attr_reader :config
+
+  def method_missing m, *args
+    config.send m, *args
+  end
+
+  def initialize cfg
+    @config = (cfg.is_a?(Hashie::Mash) ? cfg : Hashie::Mash.new(cfg))
+  end
+
+  def name
+    attributes.name
+  end
+
+  def target_class
+    Kernel.const_get type
+  end
+
+  def missing?
+    existence.empty?
+  end
+
+  def existence
+    target_class.existence attributes
+  end
+
+  def apply!
+    factory = existence
+    if factory.empty?
+      factory.create! attributes
+    else
+      factory.first.update_attributes attributes
+    end
+  end
+
+end

data/lib/protopack/version.rb

@@ -0,0 +1,3 @@
+module Protopack
+  VERSION = "0.0.1"
+end

data/lib/protopack.rb

@@ -0,0 +1,8 @@
+require "hashie"
+require "protopack/version"
+require "protopack/package"
+require "protopack/package_item"
+
+module Protopack
+  # Your code goes here...
+end

data/protopack.gemspec

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'protopack/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "protopack"
+  gem.version       = Protopack::VERSION
+  gem.authors       = ["conanite"]
+  gem.email         = ["conan@conandalton.net"]
+  gem.description   = %q{Create objects from object definitions stored as files}
+  gem.summary       = %q{Store packages of object prototypes on-disk as YML; this gem allows you scan each package for missing items and apply them to your repository.}
+  gem.homepage      = ""
+
+  gem.add_dependency             'hashie'
+  gem.add_development_dependency 'rspec', '~> 2.9'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/protopack/package_spec.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Protopack::Package do
+
+  before {
+    Protopack::Package.config_root = File.expand_path('../packages', __FILE__)
+    Widget.destroy_all
+  }
+
+  it "should find all the packages" do
+    Protopack::Package.all.map(&:name).join(" ").should == "advanced-widgets standard-widgets"
+  end
+
+  it "should find a given package" do
+    p = Protopack::Package.find("standard-widgets")
+    p.name.should == "standard-widgets"
+
+    p.title.en.should == "Standard Widgets"
+    p.title.fr.should == "Widgets standards"
+
+    p.description.en.should == "Use these widgets for everyday widgeting"
+    p.description.fr.should == "Ces widgets sont utilisables pour votre widgeting quotidien"
+
+    p.authors.should == %w{ baz titi Z }
+
+    p.updated.should == 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{ blue green red}
+  end
+
+  it "should install all items from a package, overwriting existing items" do
+    Widget.new :colour => "blue"
+    Widget.new :colour => "green"
+
+    p = Protopack::Package.find("standard-widgets")
+    p.apply_all
+
+    Widget.all.map(&:colour).should == %w{ blue green red}
+    Widget.all[0].height.should == 'elephant'
+    Widget.all[1].height.should == 'zebra'
+    Widget.all[2].height.should == 'tiger'
+  end
+
+  it "should install only missing items from a package, not overwriting existing items" do
+    Widget.new :colour => "blue"
+    Widget.new :colour => "green"
+
+    p = Protopack::Package.find("standard-widgets")
+    p.apply_missing
+
+    Widget.all.map(&:colour).should == %w{ blue green red}
+    Widget.all[0].height.should == nil
+    Widget.all[1].height.should == nil
+    Widget.all[2].height.should == 'tiger'
+  end
+
+end

data/spec/protopack/packages/advanced-widgets/lavender-widget-item.yml

@@ -0,0 +1,6 @@
+name: lavender-widget
+type: Widget
+attributes:
+  colour:  lavender
+  height:  trapeze
+  density: bittersweet

data/spec/protopack/packages/advanced-widgets/magenta-widget-item.yml

@@ -0,0 +1,6 @@
+name: magenta-widget
+type: Widget
+attributes:
+  colour:  magenta
+  height:  hippopotamus
+  density: unavailable

data/spec/protopack/packages/advanced-widgets/package-config.yml

@@ -0,0 +1,3 @@
+---
+name: advanced-widgets
+

data/spec/protopack/packages/standard-widgets/blue-widget-item.yml

@@ -0,0 +1,6 @@
+id: blue-widget
+type: Widget
+attributes:
+  colour:  blue
+  height:  elephant
+  density: difficult

data/spec/protopack/packages/standard-widgets/green-widget-item.yml

@@ -0,0 +1,6 @@
+id: green-widget
+type: Widget
+attributes:
+  colour:  green
+  height:  zebra
+  density: obtuse

data/spec/protopack/packages/standard-widgets/package-config.yml

@@ -0,0 +1,14 @@
+---
+name: standard-widgets
+title:
+  en: Standard Widgets
+  fr: Widgets standards
+description:
+  en: Use these widgets for everyday widgeting
+  fr: Ces widgets sont utilisables pour votre widgeting quotidien
+authors:
+  - baz
+  - titi
+  - Z
+updated: 2013-03-15
+

data/spec/protopack/packages/standard-widgets/red-widget-item.yml

@@ -0,0 +1,6 @@
+id: red-widget
+type: Widget
+attributes:
+  colour:  red
+  height:  tiger
+  density: abstract

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+require "rubygems"
+require "bundler"
+
+Bundler.setup
+Bundler.require
+require File.expand_path('../../lib/protopack', __FILE__)
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# 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.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+class Widget
+  @@widgets = []
+
+  def self.all
+    @@widgets
+  end
+
+  def self.destroy_all
+    @@widgets = []
+  end
+
+  def initialize attrs
+    @attrs = attrs.is_a?(Hash) ? Hashie::Mash.new(attrs) : attrs
+    @@widgets << self
+  end
+
+  def method_missing m, *args
+    @attrs.send m, *args
+  end
+
+  def update_attributes attrs
+    @attrs = attrs
+  end
+
+  def self.existence attrs
+    WidgetRepository.new attrs.colour
+  end
+end
+
+class WidgetRepository
+  def initialize name
+    @name = name
+  end
+
+  def create! attributes
+    Widget.new(attributes)
+  end
+
+  def matches
+    Widget.all.select { |w| w.colour == @name }
+  end
+
+  def empty?
+    matches.empty?
+  end
+
+  def first
+    matches.first
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: protopack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- conanite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Create objects from object definitions stored as files
+email:
+- conan@conandalton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/protopack.rb
+- lib/protopack/package.rb
+- lib/protopack/package_item.rb
+- lib/protopack/version.rb
+- protopack.gemspec
+- spec/protopack/package_spec.rb
+- spec/protopack/packages/advanced-widgets/lavender-widget-item.yml
+- spec/protopack/packages/advanced-widgets/magenta-widget-item.yml
+- spec/protopack/packages/advanced-widgets/package-config.yml
+- spec/protopack/packages/standard-widgets/blue-widget-item.yml
+- spec/protopack/packages/standard-widgets/green-widget-item.yml
+- spec/protopack/packages/standard-widgets/package-config.yml
+- spec/protopack/packages/standard-widgets/red-widget-item.yml
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Store packages of object prototypes on-disk as YML; this gem allows you scan
+  each package for missing items and apply them to your repository.
+test_files:
+- spec/protopack/package_spec.rb
+- spec/protopack/packages/advanced-widgets/lavender-widget-item.yml
+- spec/protopack/packages/advanced-widgets/magenta-widget-item.yml
+- spec/protopack/packages/advanced-widgets/package-config.yml
+- spec/protopack/packages/standard-widgets/blue-widget-item.yml
+- spec/protopack/packages/standard-widgets/green-widget-item.yml
+- spec/protopack/packages/standard-widgets/package-config.yml
+- spec/protopack/packages/standard-widgets/red-widget-item.yml
+- spec/spec_helper.rb