aston 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 825ca0a986669eb04c434775792fadf6f4127f57d82144d4fab9282d2af7e8bd
-  data.tar.gz: d6acd466695b6236f494a9b00c784f0b33a7cf61dafedb8d9d2cf1c610d5e811
+  metadata.gz: eebe5f2b036ff05e61f6e1b09233577fa2494c928c5a50ed21a6392c49e000dd
+  data.tar.gz: 60d363e3a4047ead68e7af6b16b6a7d05d9419d6918622d1c5e54b15426b8928
 SHA512:
-  metadata.gz: df8dda9a4fe333ebdc535f7cda0369a30be3478dbbc295f093a08797b9ba9345c7226339fdd10957577c1a9b631aae7caf9f62ae249f290f71dce18663c683d8
-  data.tar.gz: b0c056e04628e20b07b9b7346282d55a1e8cef5b250a7751be204d2fb4685f1042e7feb51bf4c58fb98f2e96cf00a431087fce4dbfabed96d1058053466a1909
+  metadata.gz: 0f20ae2f4e61ac774706b0c8ac136e14606485f68877817cbddfb2e27a4bd4e1a961fd898989e269dccf4313c7df0ab01d330ec0ff688938a60f6530bd6846c4
+  data.tar.gz: 14ba62157897f974353b9f7fc198213bdc4dd285718f77470f7cc0d0f261ce6e3b748f644d522b8a339d11983c4b3081d693b0ee1464ea9a2197da3ed2137f52

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aston (0.1.0)
+    aston (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,6 @@
 # Aston
 
-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/aston`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The tiny library providing a tooling to deal with _ASTON_, which is like _JSON_, but isomorphic to _XML_. 
 
 ## Installation
 
@@ -22,18 +20,123 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+Aston.new(:root).
+    then { |a| a.put_attribute([:bar, :baz], 'attr', 'value') }.
+    then { |a| a.put_content([:bar, :baz], 'Hello, world!') }
+#⇒ #<Aston:0x0000646926a11370
+#  @attributes=#<Aston::Attributes:0x0000646926a112f8 @data={}>,
+#  @content=
+#   #<Aston::Content:0x0000646926a112d0
+#    @data=
+#     [#<Aston:0x0000646926a110f0
+#       @attributes=#<Aston::Attributes:0x0000646926a11078 @data={}>,
+#       @content=
+#        #<Aston::Content:0x0000646926a11050
+#         @data=
+#          [#<Aston:0x0000646926a10f38
+#            @attributes=#<Aston::Attributes:0x0000646926a10ec0 @data={"attr"=>"value"}>,
+#            @content=#<Aston::Content:0x0000646926a10e98 @data=["Hello, world!"]>,
+#            @name=:baz>]>,
+#       @name=:bar>]>,
+#  @name=:root>
+```
+
+### `#to_s`
+
+```ruby
+puts Aston.new(:root).
+        then { |a| a.put_attribute([:bar, :baz], 'attr', 'value') }.
+        then { |a| a.put_content([:bar, :baz], "Hello, world!") }.
+        to_s
+```
+
+```xml
+<!-- Aston:1380:root -->
+<root>
+    <!-- Aston:1400:bar -->
+    <bar>
+        <!-- Aston:1420:baz -->
+        <baz attr='value'>
+            Hello, world!
+        </baz>
+    </bar>
+</root>
+```
+
+### `#to_json`
 
-## Development
+```ruby
+puts Aston.new(:root).
+        then { |a| a.put_attribute([:bar, :baz], 'attr', 'value') }.
+        then { |a| a.put_content([:bar, :baz], "Hello, world!") }.
+        to_json
+#⇒ {"name":"root","attributes":{},"content":[
+#     {"name":"bar","attributes":{},"content":[
+#        {"name":"baz","attributes":{"attr":"value"},"content":["Hello, world!"]}]}]}
+```
 
-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.
+### `Aston#parse_hash`
 
-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).
+```ruby
+json = Aston.new(:root).
+         then { |a| a.put_attribute([:bar, :baz], 'attr', 'value') }.
+         then { |a| a.put_content([:bar, :baz], "Hello, world!") }.
+         to_json
+Aston.parse_hash(JSON.parse(json))
+#⇒ #<Aston:0x0000643279caa890
+#  @attributes=#<Aston::Attributes:0x0000643279caa868 @data={}>,
+#  @content=
+#   #<Aston::Content:0x0000643279caa840
+#    @data=
+#     [#<Aston:0x0000643279caa930
+#       @attributes=#<Aston::Attributes:0x0000643279caa908 @data={}>,
+#       @content=
+#        #<Aston::Content:0x0000643279caa8e0
+#         @data=
+#          [#<Aston:0x0000643279caa9d0
+#            @attributes=#<Aston::Attributes:0x0000643279caa9a8 @data={"attr"=>"value"}>,
+#            @content=#<Aston::Content:0x0000643279caa980 @data=["Hello, world!"]>,
+#            @name="baz">]>,
+#       @name="bar">]>,
+#  @name="root">
+```
 
-## Contributing
+### `#update_in`
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/am-kantox/aston. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/am-kantox/aston/blob/master/CODE_OF_CONDUCT.md).
+```ruby
+a = Aston.new :aston, attributes: { foo: :bar }
+a.put_attribute %i[bar baz], :ok, 42
+a.put_content %i[bar baz], 'Hello'
+a.update_in %i[bar baz] do |content|
+  content <<
+    Aston.new(:seq, attributes: { name: :seq1 }) <<
+    Aston.new(:seq, attributes: { name: :seq2 }) <<
+    Aston.new(:seq, attributes: { name: :seq3 })
+end
+
+#⇒ [#<Aston:0x0000643279c616e0
+#   @attributes=#<Aston::Attributes:0x0000643279c61668 @data={:ok=>42}>,
+#   @content=
+#    #<Aston::Content:0x0000643279c61640
+#     @data=
+#      ["Hello",
+#       #<Aston:0x0000643279c60d58
+#        @attributes=#<Aston::Attributes:0x0000643279c60d08 @data={:name=>:seq1}>,
+#        @content=#<Aston::Content:0x0000643279c60ce0 @data=[]>,
+#        @name=:seq>,
+#       #<Aston:0x0000643279c60c68
+#        @attributes=#<Aston::Attributes:0x0000643279c60c18 @data={:name=>:seq2}>,
+#        @content=#<Aston::Content:0x0000643279c60bc8 @data=[]>,
+#        @name=:seq>,
+#       #<Aston:0x0000643279c60b50
+#        @attributes=#<Aston::Attributes:0x0000643279c60b00 @data={:name=>:seq3}>,
+#        @content=#<Aston::Content:0x0000643279c60ad8 @data=[]>,
+#        @name=:seq>]>,
+#   @name=:baz>]
+```
 
+`#update_in` returns an array of updated elements on the path given. Unlike `#update_in`.
 
 ## License
 

data/lib/aston/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Aston
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/aston.rb

@@ -10,7 +10,7 @@ class Aston
   class Attributes
     attr_reader :data
 
-    def initialize(data)
+    def initialize(data = {})
       @data = data
     end
 
@@ -22,10 +22,6 @@ class Aston
       @data[key] = value
     end
 
-    def to_s
-      @data.map { |k, v| "#{k}='#{v}'" }.join(' ')
-    end
-
     def ==(other)
       other.is_a?(Attributes) && @data == other.data
     end
@@ -33,13 +29,21 @@ class Aston
     def size
       @data.size
     end
+
+    def to_s
+      @data.map { |k, v| "#{k}='#{v}'" }.join(' ')
+    end
+
+    def to_json(opts = nil)
+      @data.to_json(opts)
+    end
   end
 
   # Wrapper for content
   class Content
     attr_reader :data
 
-    def initialize(data)
+    def initialize(data = [])
       @data = data
     end
 
@@ -64,6 +68,10 @@ class Aston
     def to_s
       @data.map(&:to_s).join("\n")
     end
+
+    def to_json(opts = nil)
+      @data.to_json(opts)
+    end
   end
 
   attr_reader :name, :attributes, :content
@@ -92,46 +100,55 @@ class Aston
 
   def to_s
     comment = "<!-- Aston:#{__id__}:#{name} -->"
-    opening = @attributes.data.empty? ? "<#{name}>" : ['<', name, *@attributes].join(' ') << '>'
+    opening = @attributes.data.empty? ? "<#{name}>" : ["<#{name}", *@attributes].join(' ') << '>'
     [comment, opening, *@content, "</#{name}>"].join("\n")
   end
 
+  def to_json(opts = nil)
+    { name: @name, attributes: @attributes, content: @content }.to_json(opts)
+  end
+
+  def self.parse_hash(hash)
+    name = hash.fetch('name', hash.fetch(:name, ''))
+    attributes = hash.fetch('attributes', hash.fetch(:attributes, {}))
+    content = hash.fetch('content', hash.fetch(:content, [])).map do |elem|
+      case elem
+      when String then elem
+      when Hash then Aston.parse_hash(elem)
+      end
+    end
+    Aston.new(name, attributes: attributes, content: content)
+  end
+
   def paths
     do_paths([], [])
   end
 
-  def find(name)
-    @content.data.find { |a| a.is_a?(Aston) && a.name == name }
+  def filter(name)
+    @content.data.select { |a| a.is_a?(Aston) && a.name == name }
   end
 
-  def update_in(path, create_intermediate: true, &_block)
-    yield clamber(path, create_intermediate)
+  def update_in(path, create_intermediate: true, &block)
+    clamber(path, create_intermediate).each(&block)
   rescue StandardError => e
     raise Error, e
   end
 
   def put_attribute(path, name, value, create_intermediate: true)
-    tap { clamber(path, create_intermediate)[name] = value }
+    tap { clamber(path, create_intermediate).each { |aston| aston[name] = value } }
   rescue StandardError => e
     raise Error, e
   end
 
-  def put_content(path, aston, create_intermediate: true)
-    tap { clamber(path, create_intermediate) << aston }
+  def put_content(path, content, create_intermediate: true)
+    tap { clamber(path, create_intermediate).each { |aston| aston << content } }
   rescue StandardError => e
     raise Error, e
   end
 
-  def get(path, default: nil)
-    path = fix_path(path)
-    path.reduce(self) do |memo, e|
-      current = memo.find(e)
-
-      case current
-      when NilClass then break default
-      when String then current
-      when Aston then current
-      end
+  def get(path)
+    fix_path(path).reduce([self]) do |memo, e|
+      memo.flat_map { |aston| aston.filter(e) }
     end
   end
 
@@ -149,18 +166,20 @@ class Aston
   private
 
   def clamber(path, create_intermediate)
-    fix_path(path).reduce(self) do |memo, e|
-      current = memo.find(e)
-
-      case current
-      when NilClass then create_intermediate ? Aston.new(e).tap { |aston| memo << aston } : break
-      when Aston then current
+    fix_path(path).reduce([self]) do |memo, e|
+      memo.flat_map do |aston|
+        aston.filter(e).tap do |currents|
+          next unless currents == []
+
+          value = [Aston.new(e).tap { |n| aston << n }] if create_intermediate
+          break value
+        end
       end
     end
   end
 
   def fix_path(path)
-    path = path.split('.') if path.is_a?(String)
+    # path = path.split('.') if path.is_a?(String)
     raise Error, 'Path must be an array' unless path.is_a?(Array)
 
     path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aston
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aleksei Matiushkin