project_store 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dfd310652c0a6cf26173513e71f591b4d17c72a
+  data.tar.gz: 39bf1b9f0454bbc8d536099d808707b2f2b5a5f7
+SHA512:
+  metadata.gz: e18b2cabcdf75f5039b9491f9567a2c9a5077fc7c7e74d5bae0a0f0573c8577d944ef872961e01caf9febfeaf3d16ada6dd96cef8f70dd18f662097c0bb55468
+  data.tar.gz: 41a370e11d9defce55628f2cf8b32ab0700199dc9c75fe985d1d0e16b2dec81519c1530e3d74492388efe324fe03ed3f03ca7bf6f5ba36a6fa5bf3b32e5faf5e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+.idea
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at lbnetid+gh@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Laurent B.
+
+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,41 @@
+# ProjectStore
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/project_store`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'project_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install project_store
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec #BUNDLE_SSL_CA_CERT: '/etc/ssl/certs/NanonetRootCA.pem'` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/project_store. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'project_store'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/project_store.rb

@@ -0,0 +1,22 @@
+require 'yaml/store'
+require 'logger'
+
+require 'project_store/version'
+require 'project_store/error'
+
+module ProjectStore
+  def self.logger
+    @logger ||= Logger.new STDOUT
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end
+
+
+require 'project_store/entity/mandatory_properties'
+require 'project_store/entity/common_properties'
+require 'project_store/entity/base'
+require 'project_store/editing'
+require 'project_store/base'

data/lib/project_store/base.rb

@@ -0,0 +1,77 @@
+
+
+module ProjectStore
+
+  class Base
+
+    include ProjectStore::Editing
+
+    attr_accessor :continue_on_error
+    attr_reader :path, :project_entities, :entity_types, :stores, :logger
+
+    def initialize(path)
+      raise PSE, "Invalid store path '#{path}'!" unless valid_path? path
+      @logger = ProjectStore.logger
+      @path = File.expand_path path
+      @continue_on_error = false
+      @project_entities = {}
+      @stores = {}
+      @entity_types = {}
+    end
+
+    def load_entities
+      Dir.glob(File.join(path, '*.yaml')).each do |file|
+        logger.debug "Found store file '#{file}'"
+        begin
+          store = YAML::Store.new(file)
+          stores[store] ||= []
+          store.transaction(true) do
+            store.roots.each do |entity_name|
+              begin
+                logger.debug "Loading '#{entity_name}' entity."
+                entity = store[entity_name]
+                add_and_index_entity entity, store, entity_name
+              rescue => e
+                if continue_on_error
+                  logger.error "Invalid entity of type '#{entity_name}' in file '#{file}'"
+                  logger.debug "#{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+                else
+                  logger.debug "#{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+                  raise PSE, "Invalid entity of type '#{entity_name}' in file '#{file}'"
+                end
+              end
+            end
+          end
+        rescue => e
+          logger.error "Invalid store file '#{file}'"
+          logger.debug "#{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+          raise unless continue_on_error
+        end
+      end
+    end
+
+    private
+
+    def valid_path?(path)
+      Dir.exist? path and File.readable? path and File.writable? path
+    end
+
+    def add_and_index_entity(entity, store, entity_name)
+      entity.extend ProjectStore::Entity::Base
+      entity.name = entity_name
+      entity.basic_checks
+      logger.info "Found '#{entity.name}' of type '#{entity.type}'."
+      raise PSE, "Entity '#{entity.name}' already defined in file '#{project_entities[entity.name].backing_store.path}'" if project_entities[entity.name]
+      entity.backing_store = store
+      project_entities[entity.name] = entity
+      entity_types[entity.type] ||= []
+      entity_types[entity.type] << entity
+      stores[store] << entity
+    end
+
+
+
+  end
+
+
+end

data/lib/project_store/editing.rb

@@ -0,0 +1,60 @@
+require 'tempfile'
+require 'fileutils'
+
+module ProjectStore
+
+  module Editing
+
+    attr_writer :editor
+
+    def editor
+      @editor ||= ENV['EDITOR']
+    end
+
+    def edit(file_or_entity)
+      file =  case file_or_entity
+                when String
+                  if File.exists? file_or_entity and File.readable? file_or_entity
+                    file_or_entity
+                  else
+                    raise PSE, "Invalid file to edit '#{file_or_entity}'"
+                  end
+                when ProjectStore::Entity::Base
+                  file_or_entity.backing_store.path
+              end
+      tmp_file = Tempfile.new(self.class.name).path
+      begin
+        FileUtils.copy file, tmp_file
+        edit_file tmp_file
+        begin
+          store = YAML::Store.new(tmp_file)
+          store.transaction do
+            store.roots.each do |entity_type|
+              store[entity_type]
+            end
+          end
+          FileUtils.copy tmp_file, file
+          logger.info "File '#{file}' updated successfully."
+          file
+        rescue => e
+          logger.debug "#{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+          raise PSE, 'Invalid modifications. Aborted !'
+        end
+      ensure
+        File.unlink tmp_file
+      end
+
+    end
+
+    private
+
+    def edit_file(file)
+      raise PSE, 'No editor specified' if editor.nil?
+      logger.debug "Editing file '#{file}', using editor '#{editor}'"
+      `"#{editor}" "#{file}"`
+    end
+
+
+  end
+
+end

data/lib/project_store/entity/base.rb

@@ -0,0 +1,36 @@
+module ProjectStore
+  module Entity
+
+    module Base
+
+      include ProjectStore::Entity::MandatoryProperties
+
+      attr_reader :backing_store
+
+      def backing_store=(store)
+        raise PSE, 'Cannot change the store for an entity' if @backing_store
+        @backing_store = store
+      end
+
+      def save
+        ProjectStore.logger.info "Saving '#{name}' into '#{backing_store.path}'"
+        backing_store.transaction do
+          backing_store[name] = self
+        end
+      end
+
+
+      def basic_checks
+        raise PSE, 'Invalid entity. Missing name' unless name
+        raise PSE, 'Invalid entity. You should not specify a name as it would not be taken in account' if self[:name]
+        raise PSE, "Invalid entity '#{name}'. Missing type" unless type
+        raise PSE, "Invalid entity '#{name}'. Forbidden 'backing_store' entry" if self[:backing_store]
+        raise PSE, "Invalid entity '#{name}'. Forbidden 'basic_checks' entry" if self[:basic_checks]
+        raise PSE, "Invalid entity '#{name}'. Forbidden 'save' entry" if self[:save]
+        raise PSE, "Invalid entity '#{name}'. Forbidden 'internal_type' entry" if self[:internal_type]
+      end
+
+    end
+
+  end
+end

data/lib/project_store/entity/common_properties.rb

@@ -0,0 +1,25 @@
+module ProjectStore
+  module Entity
+
+    module CommonProperties
+
+      def description
+        self[:description]
+      end
+
+      def description=(description)
+        self[:description] = description
+      end
+
+      def data
+        self[:data]
+      end
+
+      def data=(data)
+        self[:data] = data
+      end
+
+    end
+
+  end
+end

data/lib/project_store/entity/mandatory_properties.rb

@@ -0,0 +1,19 @@
+module ProjectStore
+  module Entity
+
+    module MandatoryProperties
+
+      attr_accessor :name
+
+      def type
+        self[:type]
+      end
+
+      def type=(type)
+        self[:type] = type
+      end
+
+    end
+
+  end
+end

data/lib/project_store/error.rb

@@ -0,0 +1,7 @@
+module ProjectStore
+
+  class Error < StandardError ; end
+
+end
+
+PSE = ProjectStore::Error

data/lib/project_store/initializer.rb

@@ -0,0 +1,41 @@
+require 'fileutils'
+
+module ProjectStore
+
+  module Initializer
+
+
+    def self.setup(path = Dir.pwd)
+      FileUtils.mkpath path
+    end
+
+    private
+
+    def find_store_dir(dir_basename, from_dir)
+      raise "Invalid directory '#{from_dir}'" unless Dir.exist?(from_dir) and File.readable?(from_dir)
+
+      candidate = File.join from_dir, dir_basename
+
+      if Dir.exists? candidate
+        if File.readable? candidate and File.writable? candidate
+          candidate
+        else
+          raise "Found a project directory '#{candidate}', but with wrong access rights."
+        end
+      else
+        next_dir = File.expand_path '..', from_dir
+        if next_dir == from_dir
+          raise 'No project directory found.'
+        else
+          find_store_dir dir_basename, next_dir
+        end
+      end
+
+    end
+
+
+
+  end
+
+
+end

data/lib/project_store/version.rb

@@ -0,0 +1,3 @@
+module ProjectStore
+  VERSION = '0.1.1'
+end

data/project_store.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'project_store/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'project_store'
+  spec.version       = ProjectStore::VERSION
+  spec.authors       = ['Laurent B.']
+  spec.email         = ['lbnetid+gh@gmail.com']
+
+  spec.summary       = %q{Store any Ruby object in a Yaml store.}
+  spec.description   = %q{Store, retrieve and edit a collection of Yaml entities.}
+  spec.homepage      = 'https://github.com/lbriais/project_store'
+  spec.license       = 'MIT'
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: project_store
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Laurent B.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Store, retrieve and edit a collection of Yaml entities.
+email:
+- lbnetid+gh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/project_store.rb
+- lib/project_store/base.rb
+- lib/project_store/editing.rb
+- lib/project_store/entity/base.rb
+- lib/project_store/entity/common_properties.rb
+- lib/project_store/entity/mandatory_properties.rb
+- lib/project_store/error.rb
+- lib/project_store/initializer.rb
+- lib/project_store/version.rb
+- project_store.gemspec
+homepage: https://github.com/lbriais/project_store
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Store any Ruby object in a Yaml store.
+test_files: []