ruson 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df8812fa2f70ad440c16a4647961a68955b3909d481db38bd6271534afce154c
-  data.tar.gz: d8877e9e6f435d319a736e0157845dae2264ba6468a2ed918b158601de2a8881
+  metadata.gz: d3b5eacde447ed93d7ecffd81ba095d20dad1398687f5138dd7f2267bfd5bacf
+  data.tar.gz: 172098d6792639c7c785eba55332b323785c879ce59458766d60787458b043bc
 SHA512:
-  metadata.gz: 5883b0fc7b4e95a713a906f83c1d3f07a2761cd1cf4a246f2ae6ee2591322fd24791c8ce99f37dc6e62338c4da55494d160428206838de34154e5402efcad409
-  data.tar.gz: 20fb24a41b36de01dcb8bfcb32a864ed88808f49229617a610ceb5ced0ee8a0ca3bf4204c5100120349fee63f76a79948cd09f7d4b16afcb02e34dc8a0afd44e
+  metadata.gz: 1e33b1b04e784cc26494d08fb02a26c9afa9f42bd3595c6f4527da6f59ce937c8df8b4d4b8d95bf528d6ecdbc9384cddc80de738b59d5224098fd9c4c45da3da
+  data.tar.gz: 5cb1a2daa61f905266afb804878a59a0f617e19d530649651c2fbd978c9854c87c243d1002c7baa4e11bc95b6590e75207f4a2af5942941444d378693cbec1f2

data/Dockerfile

@@ -0,0 +1,30 @@
+# How to use it
+# =============
+#
+# Visit https://blog.zedroot.org/2015/04/30/using-docker-to-maintain-a-ruby-gem/
+
+# ~~~~ Image base ~~~~
+# Base image
+FROM ruby:2.6.5-alpine
+LABEL maintainer="klriutsa"
+
+RUN mkdir -p /gem/
+WORKDIR /gem/
+ADD . /gem/
+
+# ~~~~ OS Maintenance & Rails Preparation ~~~~
+# Rubygems and Bundler
+RUN apk add --no-cache \
+            --quiet \
+            build-base \
+            git \
+  && touch ~/.gemrc \
+  && echo "gem: --no-ri --no-rdoc" >> ~/.gemrc \
+  && gem install rubygems-update \
+  && update_rubygems \
+  && gem install bundler \
+  && bundle install \
+  && rm -rf /var/cache/apk/*
+
+ENTRYPOINT ["bundle", "exec"]
+CMD ["rake", "-T"]

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Basic
+
 post.json
 ```json
 {
@@ -42,7 +44,7 @@ post.title #=> 'Ruson'
 post.content #=> 'Welcome!'
 ```
 
-### name
+#### name
 
 post.json
 ```json
@@ -65,7 +67,7 @@ post = Post.new(json)
 post.url #=> 'http://sample.com'
 ```
 
-### nilable
+#### nilable
 
 post.json
 ```json
@@ -85,9 +87,9 @@ json = File.read('post.json')
 post = Post.new(json) #=> Ruson::NotNilException
 ```
 
-### nested class
+#### nested class
 
-#### class
+##### class
 
 post.json
 ```json
@@ -119,7 +121,7 @@ post = Post.new(json)
 post.picture.url #=> 'http://sample.com/picture.png'
 ```
 
-##### Primary classes
+###### Primary classes
 
 * Boolean
 * Integer
@@ -151,7 +153,7 @@ post.view #=> 1234
 post.rate #=> 3.8
 ```
 
-#### each class
+##### each class
 
 post.json
 ```json
@@ -185,7 +187,7 @@ post = Post.new(json)
 post.tags.first.name #=> 'Ruby'
 ```
 
-### enum
+#### enum
 
 article.json
 ```json
@@ -213,7 +215,7 @@ article.status = 'undefined'
   #=> undefined is not a valid status (ArgumentError)
 ```
 
-### to_json
+#### to_json
 
 ```ruby
 class Post < Ruson::Base
@@ -228,7 +230,7 @@ post.url = 'https://example.com/examples'
 post.to_json #=> "{\"title\":\"Ruson\",\"url\":\"https://example.com/examples\"}"
 ```
 
-### to_hash
+#### to_hash
 
 ```ruby
 class Post < Ruson::Base
@@ -243,7 +245,7 @@ post.url = 'https://example.com/examples'
 post.to_hash #=> {title: "Ruson", url: "https://example.com/examples" }
 ```
 
-### API json parser
+#### API json parser
 
 ```ruby
 class Article < Ruson::Base
@@ -261,12 +263,127 @@ article = Article.new(response.body)
 article.title
 ```
 
+### Persistence
+
+Persistence will save the models as JSON file, with the model ID as filename, and model class name as parent folder so that a `User` model with ID `1` will be saved as `Users/1.json`.
+
+You *must* define the `output_folder` before to be able to call `save` or `destroy`.
+
+```ruby
+Ruson.output_folder = './db/'
+```
+
+#### Creating new record
+
+```ruby
+class User < Ruson::Base
+  field :first_name
+  field :last_name
+  field :email
+  field :title
+end
+
+# Using new + save
+guillaume = User.new(first_name: 'Guillaume', last_name: 'Briat', email: 'guillaume@kaamelott.fr')
+guillaume.save # Creates the ./db/Users/1.json file
+
+# Or using the create method
+guillaume = User.create(first_name: 'Guillaume', last_name: 'Briat', email: 'guillaume@kaamelott.fr')
+
+puts File.read('./db/Users/1.json')
+{"first_name":"Guillaume","last_name":"Briat","email":"guillaume@kaamelott.fr"}
+=> nil
+```
+
+#### Updating a record
+
+```ruby
+# Assigning a value + save
+guillaume.title = 'Burgundians King'
+guillaume.save # Updates the ./db/Users/1.json file
+
+# Or using the update method
+guillaume.update(title: 'Burgundians King')
+
+puts File.read('./db/Users/1.json')
+{"first_name":"Guillaume","last_name":"Briat","email":"guillaume@kaamelott.fr","title":"Burgundians King"}
+=> nil
+```
+
+#### Destroying a record
+
+```ruby
+guillaume.destroy # Deletes the ./db/Users/1.json file
+
+puts File.read('./db/Users/1.json')
+Traceback (most recent call last):
+       16: from /usr/local/bundle/gems/bundler-2.0.2/exe/bundle:30:in `block in <top (required)>'
+       ...
+        2: from (irb):26
+        1: from (irb):26:in `read'
+Errno::ENOENT (No such file or directory @ rb_sysopen - ./db/Users/1.json)
+```
+
+### Querying
+
+Ruson allows you to query for existing records.
+
+You *must* define the `output_folder` before to query records.
+
+```ruby
+Ruson.output_folder = './db/'
+```
+
+#### Find a record by ID
+
+```ruby
+user = User.find(1) # Searches for a ./db/Users/1.json file
+```
+
 ## Development
 
+### Without Docker
+
 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).
 
+### With Docker
+
+```
+$ docker build -t `whoami`/ruson .
+```
+
+In order to see the available Rake tasks:
+
+```
+$ docker --rm `whoami`/ruson
+rake build            # Build ruson-1.2.0.gem into the pkg directory
+rake clean            # Remove any temporary products
+rake clobber          # Remove any generated files
+rake install          # Build and install ruson-1.2.0.gem into system gems
+rake install:local    # Build and install ruson-1.2.0.gem into system gems without network access
+rake release[remote]  # Create tag v1.2.0 and build and push ruson-1.2.0.gem to rubygems.org
+rake spec             # Run RSpec code examples
+```
+_`--rm` means delete the container after the command ended._
+
+In order to execute the tests:
+
+```
+$ docker run --rm -it --volume "$PWD":/gem/ `whoami`/ruson rake spec
+```
+_`--volume` is used to sync the files from your current folder into the container so that if you change a file, the modification is available in the container._
+
+In the case you'd like to access the IRB console:
+
+```
+$ docker run --rm -it --volume "$PWD":/gem/ `whoami`/ruson irb
+irb(main):001:0> require 'ruson'
+=> true
+irb(main):002:0>
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/klriutsa/ruson. 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.

data/lib/ruson.rb

@@ -2,5 +2,6 @@ require 'ruson/base'
 require 'ruson/version'
 
 module Ruson
-
+  # Output folder where Ruson will save models data
+  mattr_accessor :output_folder
 end

data/lib/ruson/base.rb

@@ -3,13 +3,16 @@ require 'active_support'
 require 'active_support/core_ext'
 
 require 'ruson/class/boolean'
-require 'ruson/class/integer'
 require 'ruson/class/float'
+require 'ruson/class/integer'
+require 'ruson/class/time'
 
 require 'ruson/converter'
 require 'ruson/json'
-require 'ruson/value'
 require 'ruson/nilable'
+require 'ruson/persistence'
+require 'ruson/querying'
+require 'ruson/value'
 
 require 'ruson/error'
 
@@ -48,6 +51,8 @@ module Ruson
       end
 
       def add_accessor(name, options = {})
+        options[:name] = options[:name].try(:to_sym) if options[:name]
+
         @accessors ||= {}
         @accessors.merge!({ name.to_sym => options })
       end
@@ -55,8 +60,10 @@ module Ruson
 
     include Ruson::Converter
     include Ruson::Json
-    include Ruson::Value
     include Ruson::Nilable
+    include Ruson::Persistence
+    include Ruson::Querying
+    include Ruson::Value
 
     def initialize(json, root_key: nil)
       params = get_hash_from_json(json)
@@ -66,7 +73,17 @@ module Ruson
     end
 
     def to_hash
-      convert_to_hash(self.class.accessors)
+      res = convert_to_hash(self.class.accessors)
+
+      res.inject({}) do |result, attributes|
+        key, value = attributes
+        if self.class.accessors[key] && self.class.accessors[key].key?(:name)
+          result[self.class.accessors[key][:name].to_s] = value
+        else
+          result[key] = value
+        end
+        result
+      end
     end
 
     def to_json
@@ -76,18 +93,24 @@ module Ruson
     private
 
     def init_attributes(accessors, params)
+      update_attributes(accessors, params)
+
+      self.class.attr_accessor(:id)
+      set_attribute(:id, params[:id]) if params[:id]
+    end
+
+    def set_attribute(attr_name, val)
+      self.send("#{attr_name}=".to_sym, val)
+    end
+
+    def update_attributes(accessors, params)
       accessors.each do |key, options|
-        key_name = options[:name] || key
-        value = params[key_name]
+        value = params[options[:name]] || params[key]
 
         check_nilable(value, options)
         val = get_val(value, options)
         set_attribute(key, val)
       end
     end
-
-    def set_attribute(attr_name, val)
-      self.send("#{attr_name}=".to_sym, val)
-    end
   end
 end

data/lib/ruson/class/time.rb

@@ -0,0 +1,12 @@
+class Time
+  def self.new(value)
+    case value
+    when Integer, Float
+      Time.at(value).to_time
+    when String
+      Time.parse(value).to_time
+    else
+      value
+    end
+  end
+end

data/lib/ruson/converter.rb

@@ -1,7 +1,7 @@
 module Ruson
   module Converter
     def convert_to_hash(accessors)
-      accessors.keys.inject({}) do |result, key|
+      accessors.keys.inject({ id: id }) do |result, key|
         value = send(key)
         result[key.to_sym] = convert_array_to_hash_value(value)
         result

data/lib/ruson/error.rb

@@ -1,4 +1,4 @@
 module Ruson
-  class NotNilException < StandardError
-  end
-end
+  class NotNilException < StandardError; end
+  class RecordNotFound < StandardError; end
+end

data/lib/ruson/persistence.rb

@@ -0,0 +1,89 @@
+module Ruson
+  module Persistence
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def create(*args)
+        new_record = new(*args)
+        new_record.save
+        new_record
+      end
+
+      def model_base_path
+        File.join(Ruson.output_folder, "#{self.name}s")
+      end
+    end
+
+    def delete_file_from_disk
+      FileUtils.rm_f(model_path)
+    end
+
+    def destroy
+      delete_file_from_disk
+      true
+    end
+
+    def ensure_output_folder_is_defined
+      return if Ruson.output_folder
+
+      raise ArgumentError, 'No output folder defined. You can define it ' \
+                           'using Ruson.output_folder = "/path/to/db/folder"'
+    end
+
+    def ensure_model_folder_exists
+      return if File.exist?(self.class.model_base_path)
+
+      FileUtils.mkdir_p(self.class.model_base_path)
+    end
+
+    def generate_uniq_id
+      ensure_model_folder_exists
+
+      return if id
+
+      id = 0
+
+      Dir.glob(File.join(self.class.model_base_path, '*.json')).each do |file|
+        file_id = File.basename(file, '.json').to_i
+
+        id = file_id if file_id > id
+      end
+
+      self.id = id + 1
+    end
+
+    def model_path
+      File.join(self.class.model_base_path, "#{id}.json")
+    end
+
+    def write_file_to_disk
+      File.open(model_path, 'w') do |file|
+        file.write(to_json)
+      end
+    end
+
+    def save
+      ensure_output_folder_is_defined
+      generate_uniq_id
+      write_file_to_disk
+      true
+    end
+
+    def update(attributes)
+      attributes.symbolize_keys!
+
+      # Takes only accessor for attributes to be updated, avoiding to nullify
+      # the other attributes.
+      filtered_accessors = self.class.accessors.select do |key, accessor_attrs|
+        attributes.key?(key) || attributes.key?(accessor_attrs[:name])
+      end
+
+      update_attributes(filtered_accessors, attributes)
+
+      save
+    end
+  end
+end
+

data/lib/ruson/querying.rb

@@ -0,0 +1,28 @@
+module Ruson
+  module Querying
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def find(id)
+        file_path = File.join(model_base_path, "#{id}.json")
+
+        return unless File.exist?(file_path)
+
+        json = JSON.parse(File.read(file_path))
+        json[:id] = id
+
+        new json
+      end
+
+      def find!(id)
+        record = find(id)
+
+        raise Ruson::RecordNotFound unless record
+
+        record
+      end
+    end
+  end
+end

data/lib/ruson/version.rb

@@ -1,3 +1,3 @@
 module Ruson
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/ruson.gemspec

@@ -1,28 +1,31 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ruson/version"
+require 'ruson/version'
 
 Gem::Specification.new do |spec|
-  spec.name    = "ruson"
+  spec.name    = 'ruson'
   spec.version = Ruson::VERSION
-  spec.authors = ["klriutsa"]
-  spec.email   = ["hiroya.kurushima@litalico.co.jp"]
+  spec.authors = ['klriutsa']
+  spec.email   = ['hiroya.kurushima@litalico.co.jp']
 
   spec.summary     = %q{ruby json library.}
   spec.description = %q{ruby json library.}
-  spec.homepage    = "https://github.com/klriutsa/ruson"
-  spec.license     = "MIT"
+  spec.homepage    = 'https://github.com/klriutsa/ruson'
+  spec.license     = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'ffaker', '~> 2.13.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruson
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - klriutsa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 0.9.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
 description: ruby json library.
 email:
 - hiroya.kurushima@litalico.co.jp
@@ -77,6 +105,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -88,10 +117,13 @@ files:
 - lib/ruson/class/boolean.rb
 - lib/ruson/class/float.rb
 - lib/ruson/class/integer.rb
+- lib/ruson/class/time.rb
 - lib/ruson/converter.rb
 - lib/ruson/error.rb
 - lib/ruson/json.rb
 - lib/ruson/nilable.rb
+- lib/ruson/persistence.rb
+- lib/ruson/querying.rb
 - lib/ruson/value.rb
 - lib/ruson/version.rb
 - ruson.gemspec
@@ -114,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: ruby json library.