shattered_machine 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 270e23322ce44e6a921c93d0b88dbeb982b4eb28b37a2f33ac3abe38b32e6dad
-  data.tar.gz: 3b1804b2f89d4f930841858d90b45a9de764d864038cdcf8c6b82c26d98196e4
+  metadata.gz: 28ad50443747414310eb9007d97f618a1cdd855723df9ab2455b482eb1160b1f
+  data.tar.gz: fba7f95d7a020f6548f6b154c9cb89cd0b4b55c6d8427ce1b319cbd2c9294e18
 SHA512:
-  metadata.gz: 3c7af5d305304c1fff124c87e770a82bc9b1ca1851eb595e3d4ba413a7355117815a7310a9614dc118815d0751c172e14f3f07014713329c2008b8f0dcc07773
-  data.tar.gz: 02c3e621bcb430b1dde66fb232af088f70a26a564d3d761db8a92c7a606f04f6aad16fceb5811ee0d74050e61aa8f960639168d23ca0f3c6887b71d7ee6f5a47
+  metadata.gz: 73a2d147f7f27be2db8fb92962448c3fbed6d73cb3ce6933a07234f2b3f04938f614211704e9970c585a956b3e490d366664abf120dbc745b5f3c386a6649c34
+  data.tar.gz: 7ad0e654382ff1a24a495f7e9ca7e963a0c21ae6765c72f94770ca95c3b49a9171d03a1dd6abd3c0ff5add3f7b17fb0e3e7d48c7518e81822eef920041e30409

data/.gitignore

@@ -9,3 +9,4 @@ Gemfile.lock
 coverage
 doc/file.README.html
 *.gem
+.yardoc/

data/CHANGELOG

@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.3] - 2021-05-26
+### Changed
+- Replaces Rusty Engine library with the gem encapsulating those files

data/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gem 'ffi'
 gem 'pnglitch'
+gem 'rusty_engine_ffi'
 
 group :test do
   gem 'rspec'

data/README.md

@@ -1,7 +1,9 @@
 # Shattered Machine
 
-The Shattered Machine is a gem that aim to create glitched png images easily. 
+The Shattered Machine is a gem that aim to create glitched png images easily.
 
+* [Rubygems page](https://rubygems.org/gems/shattered_machine)
+* [Documentation](https://www.rubydoc.info/gems/shattered_machine)
 ## Features
 
 - Converter : Convert a single jpg images or a directory full of jpg image into png
@@ -15,7 +17,7 @@ The Shattered Machine is a gem that aim to create glitched png images easily.
 ```ruby
 require 'shattered_machine'
 
-io = ShatteredMachine::Io.new( 'input_image.png', 'output_folder', 'output_filename')
+io = ShatteredMachine::Io.new('input_image.png', 'output_folder', 'output_filename')
 ShatteredMachine::Glitcher.new('Slim', io).call
 ```
 
@@ -24,7 +26,7 @@ ShatteredMachine::Glitcher.new('Slim', io).call
 ```ruby
 require 'shattered_machine'
 
-io = ShatteredMachine::Io.new( 'input_image.png', 'output_folder', 'output_filename')
+io = ShatteredMachine::Io.new('input_image.png', 'output_folder', 'output_filename')
 ShatteredMachine::Sampler.new(io).call
 ```
 
@@ -33,11 +35,13 @@ ShatteredMachine::Sampler.new(io).call
 ```ruby
 require 'shattered_machine'
 
-io = ShatteredMachine::Io.new( 'input_image.jpg', 'output_folder', 'output_filename')
+io = ShatteredMachine::Io.new('input_image.jpg', 'output_folder', 'output_filename')
 ShatteredMachine::Converter.new(io).call
 ```
 
 ## Development
+### Install locally
+
 The Shattered Machine using two main libraries for glitching : 
 - [pnglitch](https://github.com/ucnv/pnglitch)
 - [rusty engine](https://framagit.org/Radoteur/rusty_engine)

data/lib/shattered_machine.rb

@@ -6,7 +6,7 @@ require 'shattered_machine/io'
 
 # main file for ShatteredMachine gem
 module ShatteredMachine
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
   class << self
   end

data/lib/shattered_machine/brush.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../rusty_engine/rusty_engine'
+require 'rusty_engine'
 
 module ShatteredMachine
   # Brush pixels of a given png image.

data/lib/shattered_machine/converter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../rusty_engine/rusty_engine'
+require 'rusty_engine'
 
 module ShatteredMachine
   # Convert jpg image in png image

data/lib/shattered_machine/pixel_sorter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../rusty_engine/rusty_engine'
+require 'rusty_engine'
 
 module ShatteredMachine
   # Sort pixels of a given png image.

data/lib/shattered_machine/slim.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../rusty_engine/rusty_engine'
+require 'rusty_engine'
 
 module ShatteredMachine
   # Repeat pixels of a given png image.

data/shattered_machine.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'shattered_machine'
-  s.version       = '0.0.2'
+  s.version       = '0.0.3'
   s.summary       = 'Shattered Machine core engine'
   s.description   = 'Shattered Machine is an easy way to glitch PNG images using different algorithms'
   s.authors       = ['Flo Girardo']

data/spec/spec_helper.rb

@@ -12,7 +12,6 @@ RSpec.configure do |config|
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
   $LOAD_PATH.unshift File.expand_path('..', __dir__)
-  require 'lib/rusty_engine/rusty_engine'
   require 'lib/shattered_machine/converter'
   require 'lib/shattered_machine/brush'
   require 'lib/shattered_machine/change_byte'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shattered_machine
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Flo Girardo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -47,11 +47,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".yardoc/checksums"
-- ".yardoc/complete"
-- ".yardoc/object_types"
-- ".yardoc/objects/root.dat"
-- ".yardoc/proxy_types"
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
@@ -65,7 +61,6 @@ files:
 - doc/ShatteredMachine/Io.html
 - doc/ShatteredMachine/Io/Paths.html
 - doc/ShatteredMachine/PixelSorter.html
-- doc/ShatteredMachine/RustyEngine.html
 - doc/ShatteredMachine/Sampler.html
 - doc/ShatteredMachine/Slim.html
 - doc/ShatteredMachine/Transpose.html
@@ -83,10 +78,6 @@ files:
 - doc/js/jquery.js
 - doc/method_list.html
 - doc/top-level-namespace.html
-- lib/rusty_engine/librusty_engine.dll
-- lib/rusty_engine/librusty_engine.dylib
-- lib/rusty_engine/librusty_engine.so
-- lib/rusty_engine/rusty_engine.rb
 - lib/shattered_machine.rb
 - lib/shattered_machine/brush.rb
 - lib/shattered_machine/change_byte.rb
@@ -114,7 +105,6 @@ files:
 - spec/images/fuzz.JPG
 - spec/images/pouet.JPEG
 - spec/io_spec.rb
-- spec/lib/rusty_engine_spec.rb
 - spec/pixel_sorter_spec.rb
 - spec/sampler_spec.rb
 - spec/slim_spec.rb

data/.yardoc/checksums

@@ -1,14 +0,0 @@
-lib/shattered_machine.rb e5d8db3b105d5d0409ff7211617ea36044986a0a
-lib/shattered_machine/io.rb 02fface2a883b962a3c27ffba497af8aad184993
-lib/shattered_machine/slim.rb 1f0def79e7f6631d6b9b239d5d11f512d761815f
-lib/shattered_machine/brush.rb d0c27748daffefd4b40ecee2feff395d1dd3a1da
-lib/shattered_machine/defect.rb b2402bad054d51847fd3b83d597014e8e97a2fe8
-lib/rusty_engine/rusty_engine.rb 530c6563814f0c230f14606e96468962d2ae88c3
-lib/shattered_machine/sampler.rb 51823b7678fd9da8868a2c6e847727b2d51d24b3
-lib/shattered_machine/exchange.rb d230bc77bb9dfc34ea89e55892a6a33ec028d4b6
-lib/shattered_machine/glitcher.rb 071744286d68720fe47d7dfae2e033fdcff1cf69
-lib/shattered_machine/converter.rb da5eeda73917386592612d0834a7c4d4467d5df2
-lib/shattered_machine/transpose.rb 412ae07a4bf92dd8ba7383bce7558b85ad369e6a
-lib/shattered_machine/change_byte.rb 445fc0f28fe02eaf83e711e1d616862128a86be4
-lib/shattered_machine/pixel_sorter.rb 8670ff9c56a769797654ebd41f358ce48cd72962
-lib/shattered_machine/wrong_filter.rb a71a6b72cd152d3106e266e4736369cff7fdb6b1

data/doc/ShatteredMachine/RustyEngine.html

@@ -1,122 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: ShatteredMachine::RustyEngine
-  
-    &mdash; Documentation by YARD 0.9.26
-  
-</title>
-
-  <link rel="stylesheet" href="../css/style.css" type="text/css" />
-
-  <link rel="stylesheet" href="../css/common.css" type="text/css" />
-
-<script type="text/javascript">
-  pathId = "ShatteredMachine::RustyEngine";
-  relpath = '../';
-</script>
-
-
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-
-
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-  
-    <a href="../_index.html">Index (R)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../ShatteredMachine.html" title="ShatteredMachine (module)">ShatteredMachine</a></span></span>
-     &raquo; 
-    <span class="title">RustyEngine</span>
-  
-</div>
-
-        <div id="search">
-  
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-  
-</div>
-        <div class="clear"></div>
-      </div>
-
-      <div id="content"><h1>Module: ShatteredMachine::RustyEngine
-  
-  
-  
-</h1>
-<div class="box_info">
-  
-
-  
-  
-  <dl>
-      <dt>Extended by:</dt>
-      <dd>FFI::Library</dd>
-  </dl>
-  
-  
-  
-  
-
-  
-
-  
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/rusty_engine/rusty_engine.rb</dd>
-  </dl>
-  
-</div>
-
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    
-<p>Add the following functions from the <a href="https://framagit.org/Radoteur/rusty_engine" target="_parent" title="Optional Rusty Engine">Optional Rusty Engine</a> using FFI : convert, brush, slim, sort.</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div>
-
-
-
-
-
-
-
-  
-
-</div>
-
-      <div id="footer">
-  Generated on Sun May 23 18:36:58 2021 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.6.6).
-</div>
-
-    </div>
-  </body>
-</html>

data/lib/rusty_engine/rusty_engine.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'ffi'
-
-module ShatteredMachine
-  # Add the following functions from the {https://framagit.org/Radoteur/rusty_engine Optional Rusty Engine} using FFI :
-  # convert, brush, slim, sort.
-  module RustyEngine
-    extend FFI::Library
-    lib_name = "librusty_engine.#{FFI::Platform::LIBSUFFIX}"
-    ffi_lib File.expand_path(lib_name, __dir__)
-
-    # Params : input output
-    attach_function :convert, %i[string string], :void, { blocking: true }
-
-    # Params : input output proba min max direction
-    # Directions : 1 -> horizontal
-    #              2 -> vertical
-    #              3 -> horizontal_inverted
-    #              4 -> vertical_inverted
-    attach_function :brush, %i[string string string string string string], :void, { blocking: true }
-
-    # Params : input, output, proba, probability_area, direction, colors, color_with_proba
-    # Directions : 1 -> up_to_down
-    #              2 -> down_to_up
-    #              3 -> left_to_right
-    #              4 -> right_to_left
-    attach_function :slim, %i[string string string string string string string], :void, { blocking: true }
-
-    # Params : input, output, direction, smart_sorting, detection_type, min, max, multiple_range, min_2, max_2,
-    #          sorting_by
-    # directions : 0 -> up_to_down
-    #              1 -> down_to_up
-    #              2 -> left_to_right
-    #              3 -> right_to_left
-    # detection_type : 0 -> hues
-    #                  1 -> colors
-    # sorting_by : 0 -> hue
-    #              1 -> saturation
-    attach_function :sort, %i[string string string string string string string string string string string],
-                    :void, { blocking: true }
-  end
-end

data/spec/lib/rusty_engine_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe ShatteredMachine::RustyEngine do
-  describe '.convert' do
-    let(:converted_file) { 'spec/images/converted.png' }
-    subject { ShatteredMachine::RustyEngine.convert('spec/images/foo.jpg', converted_file) }
-
-    after do
-      File.delete(converted_file) if File.exist?(converted_file)
-    end
-
-    it 'convert image' do
-      subject
-      expect(File.exist?(converted_file)).to be true
-    end
-  end
-end