nstore 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ee4be1e7cd11ed3b5d5987ab85612fce6ef7673d9c41cfbcce89621206bea1
-  data.tar.gz: 3fd3fae6277bad85a6cefccc0211ce9c279b6e14adfb68cd64c01e4aeaf8d653
+  metadata.gz: dfd4edc17a4065d5a1381cc5a675bdc777cceb2d6325b56e0518f80fa0841416
+  data.tar.gz: 67b58eba0465335ff5294a62e11768c3338c831c00b6351415cb2628b6ac78f3
 SHA512:
-  metadata.gz: 97604d80f612888e25e54f4e0b639f81b1226ba75c44d1c82d779706098b7c33a40ce4c5c0d82fff871ef0ab66931be6c6dd929921bc26fa928b3ea903872568
-  data.tar.gz: 9ce9b5d22dd8dfc3cd1c9da7820259da56394c61a140d41e72d70a05e92bf3b3d130768c6750a0712ab907482d936cbb07d46f9972469490c4200faeb8b071f1
+  metadata.gz: 8eb1321fcdc3db9929078fce412b032cf96f6b8d9f36462f8b0c0d778e814960648c4fd1afdf56704628723f4d09ad86ef7fdd309bab4b147b1790c511ed43cf
+  data.tar.gz: 15d7467a455f9b0552802c8dd113d0a64a2da25703ffb83182b298abff156183c92031e7bd4fbe2f4743d1a0e1791e089ab7ff83cf559ebf3b7d6d817f61bdcc

data/.circleci/config.yml

@@ -0,0 +1,65 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.3-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - run:
+          name: install sqlite
+          command: |
+            sudo apt-get install sqlite3
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+      - run:
+          name: install bundler
+          command: |
+            gem install bundler --pre
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+- 0.4.0 - Feature: ability to set access through an array
 - 0.3.0 - Feature: added compatibility with ActiveRecord storage
 - 0.2.1 - Feature: Ruby version and GPL v3 license has been added
 - 0.2.0 - Bugfix: create empty hash attribute after initialization

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nstore (0.3.0)
+    nstore (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,7 @@
 # NStore
 
+[![CircleCI](https://circleci.com/gh/mpakus/nstore.svg?style=svg)](https://circleci.com/gh/mpakus/nstore)
+
 Store gives you a thin wrapper around serialize for the purpose of storing hashes in a single column. It's like a simple key/value store baked into your record when you don't care about being able to query that store outside the context of a single record.
 
 You can then declare accessors to this store that are then accessible just like any other attribute of the model. This is very helpful for easily exposing store keys to a form or elsewhere that's already built around just accessing attributes on the model.
@@ -24,7 +26,7 @@ Or install it yourself as:
 
 First include NStore module to your class/model and then describe hash-map attribute, list of accessors and couple of options.
 
-```
+```ruby
   class User
     include NStore
     
@@ -46,7 +48,7 @@ First include NStore module to your class/model and then describe hash-map attri
 
 This will generate several setter and getter methods:
 
-```
+```ruby
 user = User.new
 user.profile_uid = 100
 user.profile_url
@@ -73,7 +75,7 @@ List of options:
   
 Possible to use with ActiveRecord model.
 
-```
+```ruby
 class Dump < ActiveRecord::Base
   include NStore
 
@@ -90,8 +92,7 @@ class Dump < ActiveRecord::Base
 ```
 
 creates list of methods to get and set nested values:
-```
-
+```ruby
 dump = Dump.new
 dump.board_id = 100
 dump.board_name = 'Meta'
@@ -109,6 +110,39 @@ puts dump.storage_board_name
 => "Storage Board"
 ```
 
+or just a flat array when need one level of methods, with or without prefix (be careful with attributes conflicts)
+
+```ruby
+class Dump < ActiveRecord::Base
+  include NStore
+
+  attr_accessor :member
+  attr_accessor :card
+  nstore :member,
+         accessors: [:id, :avatar],
+         prefix: true
+  nstore :card,
+         accessors: [:number, :date],
+         prefix: false         
+  ...
+```
+
+```ruby
+dump = Dump.new
+dump.member_id = 100
+dump.member_avatar = 'Avatar URL'
+dump.number = 'Card Number'
+dump.date = 'Card Date'
+puts dump.member_id
+=> 100
+puts dump.member_avatar
+=> "Avatar URL"
+puts dump.number
+=> "Card Number"
+puts dump.date
+=> "Card Date"    
+```
+
 When using couple of `nstore` declarations in the same Class, please, use `prefix: true` to avoid conflicts.
 
 ## Development

data/lib/nstore.rb

@@ -33,6 +33,7 @@ module NStore
       prefix       = options.fetch(:prefix, false)
       stringify    = options.fetch(:stringify, true)
 
+      accessors = { nil => accessors } if accessors.is_a? Array
       flat_accessors = []
       deep_flatten(accessors, [], flat_accessors)
       attribute = attribute.to_s if stringify
@@ -41,6 +42,7 @@ module NStore
 
     def _nstore_generate_accessors(attribute, flat_accessors, prefix, stringify)
       flat_accessors.each do |keys|
+        keys.reject!(&:nil?)
         keys.map!(&:to_s) if stringify
 
         define_method("#{prefix ? "#{attribute}_" : ''}#{keys.join('_')}=".to_sym) do |value|
@@ -79,10 +81,8 @@ module NStore
     end
   end
 
-  private
-
-  # @param [Symbol] attribute
-  # @param [Array] keys
+  # @param [Symbol,String] attribute
+  # @param [Array<String,Symbol>] keys
   # @param [Object] value
   def write_nstore_attribute(attribute, keys, value)
     send("#{attribute}=", {}) if send(attribute).nil?
@@ -95,11 +95,10 @@ module NStore
     position[keys[-1]] = value
   end
 
+  # @param [Symbol,String] attribute
+  # @param [Array<String,Symbol>] keys
+  # @return [Object]
   def read_nstore_attribute(attribute, keys)
     send(attribute).send(:dig, *keys)
   end
-
-  def nstore_key_brakets(attribute, keys)
-    ([attribute] + keys).map { |k| "['#{k}']" }.join
-  end
 end

data/lib/nstore/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NStore
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/nstore.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3.1'
 
   spec.metadata = {
-    'changelog_uri' => 'https://github.com/mpakus/nstore/CHANGELOG.md',
+    'changelog_uri' => 'https://github.com/mpakus/nstore/blob/master/CHANGELOG.md',
     'documentation_uri' => 'https://github.com/mpakus/nstore',
     'homepage_uri' => 'https://github.com/mpakus/nstore',
     'source_code_uri' => 'https://github.com/mpakus/nstore'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nstore
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Renat "MpaK" Ibragimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2019-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -136,7 +137,7 @@ homepage: https://github.com/mpakus/nstore
 licenses:
 - GPL-3
 metadata:
-  changelog_uri: https://github.com/mpakus/nstore/CHANGELOG.md
+  changelog_uri: https://github.com/mpakus/nstore/blob/master/CHANGELOG.md
   documentation_uri: https://github.com/mpakus/nstore
   homepage_uri: https://github.com/mpakus/nstore
   source_code_uri: https://github.com/mpakus/nstore
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: NStore - nested attributes accessors.