jsong 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 421803481a2af0dace7b3367e55378b8a5779b62
-  data.tar.gz: ff9df8bf450a50beb09816445178340538227409
+  metadata.gz: 05bb0fef8f7a98bf283a9e4378895ce32b1cd2df
+  data.tar.gz: feeafcd168d8270690fd11d93aafffa45a1c2f19
 SHA512:
-  metadata.gz: 704121c276cac4092d59f2333a6f741e43aa40f560de57bac720bb898467b90e8f6e74b4c79276b105ee9bd37ea1c8631f9741555303856419d719a5acecaab1
-  data.tar.gz: 3815064c2edd14584c085f442b1028ca84b406b2228bb70b63f6efedeb62bc3db18a44a24c226a01d0a2538b21e4e839a4878ec8f1260aa4a870ec70eec45f67
+  metadata.gz: 4b1bf34f0ac19063ed6c0d8e95613bd2a73408b02fe1b37fa54bcef8fbb05c9240444bfce8dd6091601a8224d4567ce9b72c9307008dc17f2c0e2eec05a3823d
+  data.tar.gz: d9d80e894e4f42cdb48eb9ba0028cadc004d85be8ce3484332d10bcec4d4c86077719020051c85088314d2c425cd6738634948d2fd6605a9761e294073c827ec

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsong.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 fwrs
+
+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,58 @@
+# Jsong
+
+Jsong is an encoder for the popular JSON-G format, written in Ruby. *Currently only supports PNG.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsong'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsong
+
+## Tested
+
+Yes
+
+## Usage
+
+```rb
+require 'jsong'
+
+# Get JSON-G encoded image text
+jsong_text = Jsong.to_jsong('./sample_data/tomato.png', 'nice tomato')
+
+# Turn that back into an image
+Jsong.from_jsong(jsong_text, './sample_data/tomato.png')
+```
+
+### Similar Projects
+* [json-g.rs Rust crate](https://github.com/zeyla/json-g.rs)
+* [JSON-G library index](https://github.com/Roadcrosser/JSON-G/blob/master/resources.md)
+
+
+### Reference
+[JSON-G Specification](https://github.com/Roadcrosser/JSON-G/blob/master/spec.md)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jsong. 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/jsong.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsong/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsong"
+  spec.version       = Jsong::VERSION
+  spec.authors       = ["Illia K."]
+  spec.email         = ["fwrs@users.noreply.github.com"]
+
+  spec.summary       = %q{Jsong is an encoder for the popular JSON-G format written in Ruby.}
+  spec.homepage      = "https://github.com/fwrs/jsong"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_dependency 'chunky_png', '~> 1.3'
+end

data/lib/jsong/version.rb

@@ -0,0 +1,3 @@
+module Jsong
+  VERSION = "0.2.0"
+end

data/lib/jsong.rb

@@ -0,0 +1,87 @@
+require 'jsong/version'
+require 'chunky_png'
+require 'json'
+
+module Jsong
+  DEFAULT = {
+    version: '1.0',
+    transparency: true,
+    size: {},
+    layers: [{
+      default_colour: {
+        red: 0,
+        green: 0,
+        blue: 0,
+        alpha: 255
+      },
+      pixels: []
+    }]
+  }.freeze
+
+  def Jsong.to_jsong(file_name, comment = nil)
+    image = ChunkyPNG::Image.from_file file_name
+
+    if comment.nil? && image.metadata['Title']
+      comment = image.metadata['Title']
+    elsif comment.nil?
+      comment = 'Created with ruby Jsong gem'
+    end
+
+    data = DEFAULT.dup
+
+    data[:comment] = comment
+    data[:size][:width] = image.width
+    data[:size][:height] = image.height
+
+    image.pixels.each_slice(image.width).with_index do |arr, y|
+      arr.each_with_index do |pixel, x|
+        data[:layers][0][:pixels] << {
+          position: {
+            x: x,
+            y: y
+          },
+          color: Jsong.rrggbbaa_to_jsong(pixel),
+          comment: 'A pixel'
+        }
+      end
+    end
+
+    data.to_json
+  end
+
+  def Jsong.from_jsong(json_text, file_name)
+    json_text = json_text.read if json_text.respond_to? :read
+    data = JSON.parse json_text
+    default_colour = Jsong.encode_pixel data['layers'][-1]['default_colour']
+    w, h = data['size']['width'], data['size']['height']
+
+    png = ChunkyPNG::Image.new(w, h, default_colour)
+    png.metadata['Title'] = data['comment']
+
+    data['layers'].reverse.each do |layer|
+      layer['pixels'].each do |px|
+        x, y = px['position']['x'], px['position']['y']
+        pixel = Jsong.encode_pixel px['color']
+        png.set_pixel x, y, pixel
+      end
+    end
+
+    png.save(file_name, :interlace => true)
+  end
+
+  def Jsong.encode_pixel(px)
+    r, g = px['red'],  px['green']
+    b, a = px['blue'], px['alpha']
+
+    ChunkyPNG::Color.rgba(r, g, b, a)
+  end
+
+  def Jsong.rrggbbaa_to_jsong(i)
+    {
+      red: (i / 16777216).floor,
+      green: (i / 65536).floor & 0xFF,
+      blue: (i / 256).floor & 0xFF,
+      alpha: i & 0xFF
+    }
+  end
+end