json_canvas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dbe2e6180658f10ea38a5782675140eb70e38739703bf60b57ece49d166e9e0a
+  data.tar.gz: 39cd1729ad8e72ed49d8640efabae67ef5c2310a16b02544c93c3f4292ac725c
+SHA512:
+  metadata.gz: 3bfe2c08f98160c0a96b2e08f92f7dfcbab6c13aa69d5f928067fea1b20e3f42d9a650ce22196b0d481afcf742012bb5344366abe46517f66708067697fe7472
+  data.tar.gz: f98b2390fc75a8d135e3507825c9ae6a08f9e16ae3d357b8f74c6da52b7442f43a14ccc376efdd0bb56083b000b5e94a5b1bc9bff3ec718c518d86ec493bf29e

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in json_canvas.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "test-unit", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    json_canvas (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    power_assert (2.0.3)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.35.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.62.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    test-unit (3.6.2)
+      power_assert
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x64-mingw-ucrt
+  x86_64-linux
+
+DEPENDENCIES
+  json_canvas!
+  rake (~> 13.0)
+  standard (~> 1.3)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   2.5.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 ongaeshi
+
+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,113 @@
+# JsonCanvas
+
+[JSONCanvas](https://jsoncanvas.org/spec/1.0/) Implementation for Ruby.
+
+## Installation
+
+To install JsonCanvas gem, add this line to your application's Gemfile:
+
+```bash
+gem 'json_canvas'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install json_canvas
+```
+
+## Usage
+
+
+To use JSONCanvas, include the gem in your Ruby script:
+
+```ruby
+require 'json_canvas'
+```
+
+### Creating a Canvas
+
+Create a new canvas using:
+
+```ruby
+jc = JsonCanvas.create
+```
+
+### Adding Text Nodes
+
+Add text nodes to the canvas:
+
+```ruby
+text_node = jc.add_text(text: "Hi")
+```
+
+You can customize the text node with parameters like id, position, size, content and color:
+
+```ruby
+custom_text = jc.add_text(id: "unique_id", x: 50, y: 100, width: 200, height: 50, text: "Hello World!", color: "2")
+```
+
+![image](https://github.com/ongaeshi/json_canvas/assets/154418/4138e411-3d21-4637-bd1b-3cdebe69a398)
+
+### Advanced Node Types
+
+Add file and link nodes with specific attributes:
+
+```ruby
+file_node = jc.add_file(file: "path/to/file")
+link_node = jc.add_link(url: "https://example.com")
+group_node = jc.add_group(label: "Test Group")
+```
+
+### Edge
+
+Connect nodes with edges:
+
+```ruby
+jc = JsonCanvas.create
+start = jc.add_text(id: "START", text: "start")
+goal = jc.add_text(id: "GOAL", x: 400, text: "goal")
+jc.add_edge(id: "edge1", fromNode: start.id, toNode: goal.id)
+jc.add_edge(id: "edge2", fromNode: start.id, fromSide: "top", fromEnd: "arrow", toNode: goal.id, toSide: "bottom", toEnd: "arrow", color: "2", label: "HELLO")
+```
+
+![image](https://github.com/ongaeshi/json_canvas/assets/154418/820d4709-c9fd-41a6-9548-fe6b52177273)
+
+### Get JSON string
+
+To convert your canvas instance into a JSON string, you can use the `to_json` method. 
+
+```ruby
+jc.to_json  #=> '{"nodes":[{"id":"START","x":0,"y":0,"width":250,"height":60,"type":"text","text":"start"},{"id":"GOAL","x":400,"y":0,"width":250,"height":60,"type":"text","text":"goal"}],"edges":[{"id":"edge1","fromNode":"START","toNode":"GOAL","fromSide":"right","toSide":"left"},{"id":"edge2","fromNode":"START","toNode":"GOAL","fromSide":"top","fromEnd":"arrow","toSide":"bottom","toEnd":"arrow","color":"2","label":"HELLO"}]}'
+```
+
+### Saving and Loading
+Save the canvas to a file or load from it:
+
+```ruby
+# Save to "sample.canvas" file.
+jc.save("sample.canvas")
+
+# Load to canvas object.
+loaded_canvas = JsonCanvas.parse(File.read("sample.canvas"))
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` 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 the created tag, 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/ongaeshi/json_canvas.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/json_canvas/canvas.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "json"
+require "json_canvas/node"
+require "json_canvas/edge"
+
+module JsonCanvas
+  class Canvas
+    attr_reader :nodes, :edges
+
+    def self.parse(json)
+      obj = JSON.parse(json)
+      nodes = obj["nodes"].map do |x|
+        case x["type"]
+        when "text"
+          TextNode.new(**x.transform_keys(&:to_sym))
+        when "file"
+          FileNode.new(**x.transform_keys(&:to_sym))
+        when "link"
+          LinkNode.new(**x.transform_keys(&:to_sym))
+        when "group"
+          GroupNode.new(**x.transform_keys(&:to_sym))
+        else
+          raise
+        end
+      end
+      edges = obj["edges"].map { |x| Edge.new(**x.transform_keys(&:to_sym)) }
+      Canvas.new(nodes, edges)
+    end
+
+    def initialize(nodes = [], edges = [])
+      @nodes = nodes
+      @edges = edges
+    end
+
+    def add_text(**)
+      node = TextNode.new(**)
+      nodes.push(node)
+      node
+    end
+
+    def add_file(**)
+      node = FileNode.new(**)
+      nodes.push(node)
+      node
+    end
+
+    def add_link(**)
+      node = LinkNode.new(**)
+      nodes.push(node)
+      node
+    end
+
+    def add_group(**)
+      node = GroupNode.new(**)
+      nodes.push(node)
+      node
+    end
+
+    def add_edge(**)
+      edge = Edge.new(**)
+      edges.push(edge)
+      edge
+    end
+
+    def to_json
+      JSON.generate({
+        nodes: nodes.map { |x| x.to_hash },
+        edges: edges.map { |x| x.to_hash }
+      })
+    end
+
+    def save(filename)
+      File.write(filename, to_json)
+    end
+  end
+end

data/lib/json_canvas/edge.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module JsonCanvas
+  class Edge
+    attr_accessor :id, :from_node, :from_side, :from_end, :to_node, :to_side, :to_end, :color, :label
+
+    def initialize(**kwargs)
+      @id = kwargs[:id] || SecureRandom.uuid.delete("-")[0...16]
+      @from_node = kwargs[:fromNode] || raise
+      @from_side = kwargs[:fromSide] || "right" # "top" | "right" | "bottom" | "left"
+      @from_end = kwargs[:fromEnd] # "none" | "arrow"
+      @to_node = kwargs[:toNode] || raise
+      @to_side = kwargs[:toSide] || "left"
+      @to_end = kwargs[:toEnd]
+      @color = kwargs[:color]
+      @label = kwargs[:label]
+    end
+
+    def to_hash
+      h = {
+        "id" => id,
+        "fromNode" => from_node,
+        "toNode" => to_node
+      }
+      h["fromSide"] = from_side if from_side
+      h["fromEnd"] = from_end if from_end
+      h["toSide"] = to_side if to_side
+      h["toEnd"] = to_end if to_end
+      h["color"] = color if color
+      h["label"] = label if label
+      h
+    end
+  end
+end

data/lib/json_canvas/node.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module JsonCanvas
+  class GenericNode
+    attr_accessor :id, :x, :y, :width, :height, :color
+
+    def initialize(**kwargs)
+      @id = kwargs[:id] || SecureRandom.uuid.delete("-")[0...16]
+      @x = kwargs[:x] || 0
+      @y = kwargs[:y] || 0
+      @width = kwargs[:width] || default_width
+      @height = kwargs[:height] || default_height
+      @color = kwargs[:color] # Optional
+    end
+
+    def default_width = is_a?(TextNode) ? 250 : 400
+
+    def default_height = is_a?(TextNode) ? 60 : 400
+
+    def to_hash_common(type)
+      h = {
+        "id" => id,
+        "x" => x,
+        "y" => y,
+        "width" => width,
+        "height" => height
+      }
+      h["color"] = color if color
+      h["type"] = type
+      h
+    end
+  end
+
+  class TextNode < GenericNode
+    attr_accessor :type, :text
+
+    def initialize(**kwargs)
+      super(**kwargs)
+      @type = "text"
+      @text = kwargs[:text] || ""
+    end
+
+    def to_hash
+      h = to_hash_common(type)
+      h["text"] = text
+      h
+    end
+  end
+
+  class FileNode < GenericNode
+    attr_accessor :type, :file, :subpath
+
+    def initialize(**kwargs)
+      super(**kwargs)
+      @type = "file"
+      @file = kwargs[:file] || ""
+      @subpath = kwargs[:subpath]
+    end
+
+    def to_hash
+      h = to_hash_common(type)
+      h["file"] = file
+      h["subpath"] = subpath if subpath
+      h
+    end
+  end
+
+  class LinkNode < GenericNode
+    attr_accessor :type, :url
+
+    def initialize(**kwargs)
+      super(**kwargs)
+      @type = "link"
+      @url = kwargs[:url] || "https://www.ruby-lang.org"
+    end
+
+    def to_hash
+      h = to_hash_common(type)
+      h["url"] = url
+      h
+    end
+  end
+
+  class GroupNode < GenericNode
+    attr_accessor :type, :label, :background, :background_style
+
+    def initialize(**kwargs)
+      super(**kwargs)
+      @type = "group"
+      @label = kwargs[:label]
+      @background = kwargs[:background]
+      @background_style = kwargs[:backgroundStyle]
+    end
+
+    def to_hash
+      h = to_hash_common(type)
+      h["label"] = label if label
+      h["background"] = background if background
+      h["backgroundStyle"] = background_style if background_style
+      h
+    end
+  end
+end

data/lib/json_canvas/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonCanvas
+  VERSION = "0.1.0"
+end

data/lib/json_canvas.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "json_canvas/canvas"
+require "json_canvas/edge"
+require "json_canvas/node"
+require "json_canvas/version"
+
+module JsonCanvas
+  def self.create
+    Canvas.new
+  end
+
+  def self.parse(json)
+    Canvas.parse(json)
+  end
+end

data/sig/json_canvas.rbs

@@ -0,0 +1,4 @@
+module JsonCanvas
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: json_canvas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ongaeshi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-07 00:00:00.000000000 Z
+dependencies: []
+description: JsonCanvas is a Ruby gem that provides a robust implementation of the
+  JSONCanvas specification. This gem enables developers to easily create and manipulate
+  JSONCanvas format. It supports functionalities such as adding text, files, links,
+  and grouping nodes with customizable attributes like position, size, and identifiers.
+  Additional features include connecting nodes with edges that have customizable attributes,
+  and the ability to save and load canvas states from JSON files. This gem facilitates
+  the easy integration of the JSONCanvas format into Ruby applications, enhancing
+  development efficiency and user experience.
+email:
+- ongaeshi0621@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/json_canvas.rb
+- lib/json_canvas/canvas.rb
+- lib/json_canvas/edge.rb
+- lib/json_canvas/node.rb
+- lib/json_canvas/version.rb
+- sig/json_canvas.rbs
+homepage: https://github.com/ongaeshi/json_canvas
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ongaeshi/json_canvas
+  source_code_uri: https://github.com/ongaeshi/json_canvas
+  changelog_uri: https://github.com/ongaeshi/json_canvas/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: JSONCanvas Implementation for Ruby.
+test_files: []