project_store 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4819203c3889f05232a0afd13a05894d3077cf1a
-  data.tar.gz: c2f6683a99c1d3f19dfc5bdcef92b223ceb24403
+  metadata.gz: e14c2c57045fc7b870aee3abc5d80ce5a50337b2
+  data.tar.gz: 29ac6c2d7c6aaf39a136a7f7b865ba1b749fa471
 SHA512:
-  metadata.gz: f4531161effa7a1c94176481a6b800a308f3e7814d929e7674ccf718dc061b6914e1fc248cf34aa0ec70bc4308c81ddddbf69a2c7fc56ca65f66b3a52fc5cef7
-  data.tar.gz: 3ddf7c1396fcc60206e03ee0f56f37330b0b8ec86698f3134983db6e6a9c3a621e77025ed55da5b6c35c8d8905c07e241e8c805af38524e3c4c06a62c58342ec
+  metadata.gz: 4707b6b39ba31f32a2f3426fa6740c92a769152dd1831e22af5df9f1f632801d68fb1039e07099e0569565fb6fd36ea55e9c93541d6c6ff4a21b964997218db3
+  data.tar.gz: 7bc33d14d4a7cd9a47963b1b71979498c99fd949d59162ad826bc5b0d3e5b6ef80e41d70b5ad0137c7eb71ba911b080d953fa0daa153e2c72a8eb6b4f8eaa369

data/.travis.yml

@@ -2,3 +2,5 @@ language: ruby
 rvm:
   - 2.2.4
 before_install: gem install bundler -v 1.11.2
+script:
+  - bundle exec rspec -f d 2> /dev/null

data/README.md

@@ -1,8 +1,14 @@
 # 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.
+`project_store` is a simple gem to persist a collection of Ruby objects in a Yaml based backing store.  
+ As opposed to standard Yaml persistence mechanisms, the dump/reload mechanism is based on the `type` (as
+ in the `type` property) of objects.
+ 
+ All objects are actually pure hashes "decorated" by some modules depending on their `type` property.
+  
+ By default any object loaded from a store will have the `ProjectStore::Entity::Base` module "applied" (the hash read 
+ from the yaml backend will extend that module).
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,20 +28,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The only real two objects you have to use are:
+
+* `ProjectStore::Base` which represents a yaml datastore
+* `ProjectStore::Entity::Base` which represents a basic object loaded from yaml
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `rake spec` 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).
+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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/lbriais/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/lib/project_store/editing.rb

@@ -6,45 +6,59 @@ module ProjectStore
   module Editing
 
     EDITOR_ENVIRONMENT_VARIABLE = 'DM_EDITOR'
+    EDIT_RETRY_ENVIRONMENT_VARIABLE = 'DM_EDIT_RETRY'
+    DEFAULT_RETRY_MAX_COUNT = 1
+    ERROR_FILE_KEPT = '/tmp/last-failed-edit.yaml'
 
-    attr_writer :editor
+    attr_writer :editor, :nb_max_edit_retries
 
     def editor
       @editor ||= ENV[EDITOR_ENVIRONMENT_VARIABLE]
     end
 
+    def nb_max_edit_retries
+      default = ENV[EDIT_RETRY_ENVIRONMENT_VARIABLE].to_i unless ENV[EDIT_RETRY_ENVIRONMENT_VARIABLE].nil?
+      default ||= DEFAULT_RETRY_MAX_COUNT
+      @nb_max_edit_retries ||= default
+    end
+
     def edit(file_or_entity, &block)
-      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
+      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, '.yaml']).path
       begin
-        FileUtils.copy file, tmp_file
+        retry_count ||= 1
+        FileUtils.copy file, tmp_file if retry_count == 1
         edit_file tmp_file
-        # begin
-          store = YAML::Store.new(tmp_file)
-          store.transaction do
-            store.roots.each do |entity_name|
-              entity = store[entity_name]
-              setup_entity! entity_name, entity, &block
-              entity.valid_to_save? raise_exception: true
-            end
+
+        store = YAML::Store.new(tmp_file)
+        store.transaction do
+          store.roots.each do |entity_name|
+            entity = store[entity_name]
+            setup_entity! entity_name, entity, &block
+            entity.valid_to_save? raise_exception: true
           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
+        end
+        FileUtils.copy tmp_file, file
+        logger.info "File '#{file}' updated successfully."
+        file
+      rescue StandardError => e
+        retry_count += 1
+        retry unless retry_count > nb_max_edit_retries
+        raise e
       ensure
+        if retry_count > nb_max_edit_retries
+          logger.error "Keeping file '#{ERROR_FILE_KEPT}' which was invalid !"
+          FileUtils.copy tmp_file, ERROR_FILE_KEPT
+        end
         File.unlink tmp_file
       end
 

data/lib/project_store/version.rb

@@ -1,3 +1,3 @@
 module ProjectStore
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: project_store
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
+date: 2017-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler