gifenc 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f9e18acc20b6acafb26735998f88134ede1cef587114377b996c6ec1c3e6432
-  data.tar.gz: 7a18a82e735f39c023bf9b7cf4918ad13fa2e0ea59e6c5594f9ddf969f7e8624
+  metadata.gz: 5c38b840026c2289d2524c5e06bf2d1943b468662bd45a0f7abe456a6405badc
+  data.tar.gz: fc17037791eff68a2fec84b7689b082726e51aa1363b1e94885a9535f4b37db1
 SHA512:
-  metadata.gz: b11f2d061f5443a35d4134f077a2ae529b5084bde5ae42f449fb11c7ac0b8c9c7b7c359110b978494e2f96ac5b0f8bc9cae8e0156d1fb5598e22f2c06d92f2f1
-  data.tar.gz: f9c1e03801eebffbf4e78c48a90c49e040e1b87f3bc3f8d34c8ec8d069008456276e5c3333d5af53edfe4006518ec2f65ff92bdcf4730856556615682c41e411
+  metadata.gz: 54367e7f3751f0370fe6e4a297fb29b323a25d25ad9ef0e9a435ec8df3cc6010ff2f012d41cda0195cb8a42456069e15a03f3fdfd78f0990be1ecb78fd5f35f9
+  data.tar.gz: 12e4facd900f5628554bfc479044ffe33df18dfaf365586dbc259eeace2e643c9cecb6b187c7276f0eba64b04c1e4f987486635d0e4bae0d2572453d9b795962

data/.yardopts

@@ -1 +1 @@
-lib/**/*.rb -m markdown --no-private - docs/**/*
+lib/**/*.rb -m markdown --no-private - CHANGELOG.md docs/**/*

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+### 0.2.1 (18/Mar/2024)
+
+Improved the image copy method. It now automatically corrects both source and destination offsets / dimensions to prevent any out of bounds errors, allows to specify a bounding box to which the copying should be restricted to, and allows to "copy with transparency", which will copy every color except for the transparent one.
+
+### 0.2.0 (05/Mar/2024)
+
+A big update, with the main changes being divided in two categories: mathematical methods and drawing methods.
+
+- Added a `Geometry` module that abstracts a lot of mathematical - and more specifically geometrical - functionality, that is useful throughout the program, but particularly for drawing. A Point class is included, which represents both 2D points and vectors, depending on context. This module includes:
+  * Bound checking, calculation of bounding boxes and convex hulls.
+  * Changes of coordinates, cartesian and polar coordinate support, etc.
+  * Point operations, such as translations, dilations / scalings, linear and convex combinations, scalar product, center of mass, etc.
+  * Point transformations, such as rotations, projections and reflections.
+  * Norms (L1, euclidean, supremum), normalization, distances.
+  * Angles, parallelism, orthogonality, normal vectors...
+
+- Significantly expanded the drawing functionality, including:
+  * Improved line drawing, and added line styles (dashed, dotted, etc).
+  * Added circles and general (axis-aligned) ellipses.
+  * Added grids, polygonal chains and spirals.
+  * Arbitrary parametric curves and function graphs given a lambda function.
+  * Implemented the flood fill / bucket tool.
+  * Added a general Brush class to enable more flexible drawing.
+
+Many sample GIFs, showcasing all this new functionality, were added in the [Examples](https://github.com/edelkas/gifenc/tree/master/examples) folder as well.
+
+- Additional new functionality includes:
+  * Copy: Ability to copy a region from one image to another.
+  * Compress: Ability to LZW-compress image data on the fly, instead of keeping
+    everything raw in memory until final encode time. Particularly helpful for
+    GIFs with thousands of frames on systems with low memory.
+
+### 0.1.0 (14/Feb/2024)
+
+Initial release. Includes:
+
+- Encoding working, with support for most of the specification (missing interlacing and Plain Text / Comment extensions).
+- Basic color table and image manipulation.
+- A few drawing primitives (lines and rectangles).

data/README.md

@@ -1,12 +1,17 @@
 # gifenc
 
+[![Gem Version](https://img.shields.io/gem/v/gifenc.svg)](https://rubygems.org/gems/gifenc)
+[![Gem](https://img.shields.io/gem/dt/gifenc.svg)](https://rubygems.org/gems/gifenc)
+[![Documentation](https://img.shields.io/badge/docs-grey.svg)](https://www.rubydoc.info/gems/gifenc)
+[![Examples](https://img.shields.io/badge/examples-grey.svg)](https://github.com/edelkas/gifenc/tree/master/examples)
+
 A pure Ruby library with no external dependencies that allows to encode, decode and edit GIFs. Its main goals are to:
 
 * Support the full GIF [specification](https://www.w3.org/Graphics/GIF/spec-gif89a.txt) for both encoding and decoding.
 * Have a decent suite of editing functionalities, so that the need for external tools is avoided as much as possible.
 * Have a succint and comfortable syntax to use.
 
-Currently, the specs are almost fully supported for encoding. Decoding is not yet available, and the editing methods are very limited.
+Currently, the specs are almost fully supported for encoding. Decoding is not yet available, but will be soon. There's a solid `Geometry` module and decent drawing functionality. See the [Reference](https://www.rubydoc.info/gems/gifenc) for the full documentation, as well as [Examples](https://github.com/edelkas/gifenc/tree/master/examples) for a list of sample snippets and GIFs.
 
 ## A first example
 
@@ -46,7 +51,7 @@ end
 gif.save('test.gif')
 ```
 
-Let's see a step-by-step overview, refer to the following sections for an in-depth explanation of the actual details for each of the topics involved.
+Let's see a step-by-step overview, refer to the documentation for an in-depth explanation of the actual details for each of the topics involved.
 1. The first thing we do is create two **Color Tables**, one with red shades, and another with green shades. Since GIF is an indexed image format, it can only use colors from predefined palettes of at most 256 colors. `Gifenc` comes equipped with several default ones, but you can build your own, and operate with them.
 2. We create the GIF object. We select the red color table to be the **GCT** (_Global Color Table_), which is used for all frames that do not contain an explicit **LCT** (_Local Color Table_). We also set the GIF to loop indefinitely.
 3. We create the first frame, this will act as the background. We use the green color table as LCT for this frame. We set a few attributes, such as the default color of the canvas, the length of the frame, and the color used for transparency. We draw a sequence of centered green squares, they will help to see the transparency of the next frames.
@@ -55,7 +60,7 @@ Let's see a step-by-step overview, refer to the following sections for an in-dep
 
 Producing the second variation is surprisingly simple. It suffices to add the option `disposal: Gifenc::DISPOSAL_PREV` to the frames (except for the background). More on this later.
 
-See the [Examples](examples) folder for more code samples; the resulting GIFs are stored [here](res).
+See the [Examples](https://github.com/edelkas/gifenc/tree/master/examples) folder for more code samples; the resulting GIFs are stored [here](https://github.com/edelkas/gifenc/tree/master/res).
 
 ## Resources
 

data/lib/errors.rb

@@ -20,5 +20,9 @@ module Gifenc
     # such as trying to append 2 Graphic Control Extensions to the same image.
     class ExtensionError < Exception
     end
+
+    # Raised when a mathematic error happens in any of the calculations.
+    class GeometryError < Exception
+    end
   end
 end

data/lib/extensions.rb

@@ -7,7 +7,7 @@ module Gifenc
   class Extension
 
     # 1-byte field indicating the beginning of an extension block.
-    EXTENSION_INTRODUCER = '!'
+    EXTENSION_INTRODUCER = '!'.freeze
 
     # Create a new generic extension block.
     # @param label [Integer] Label of the extension, uniquely identifies the type of extension.
@@ -20,8 +20,8 @@ module Gifenc
     # @param stream [IO] Stream to write the data to.
     def encode(stream)
       stream << EXTENSION_INTRODUCER
-      stream << @label.chr # Extension label
-      stream << body       # Extension content
+      stream << @label # Extension label
+      stream << body   # Extension content
     end
 
     # This extension precedes a *single* image and controls several of its rendering
@@ -67,7 +67,7 @@ module Gifenc
     class GraphicControl < Extension
 
       # Label identifying a Graphic Control Extension block.
-      LABEL = 0xF9
+      LABEL = "\xF9".freeze
 
       # Specifies the time, in 1/100ths of a second, to leave this image onscreen
       # before moving on to rendering the next one in the GIF. Must be between
@@ -150,15 +150,15 @@ module Gifenc
           ((@disposal || DEFAULT_DISPOSAL) & 0b111) << 2 |
           ((@user_input    ? 1 : 0)        & 0b1  ) << 1 |
           ((!!@trans_color ? 1 : 0)        & 0b1  )
-        ].pack('C')
+        ].pack('C'.freeze)
         trans_color = !@trans_color ? DEFAULT_TRANS_COLOR : @trans_color
 
         # Main params
-        str = "\x04"                   # Block size (always 4 bytes)
-        str += flags                   # Packed fields
-        str += [@delay].pack('S<')     # Delay time
-        str += [trans_color].pack('C') # Transparent index
-        str += BLOCK_TERMINATOR
+        str = "\x04"                          # Block size (always 4 bytes)
+        str << flags                          # Packed fields
+        str << [@delay].pack('S<'.freeze)     # Delay time
+        str << [trans_color].pack('C'.freeze) # Transparent index
+        str << BLOCK_TERMINATOR
 
         str
       end
@@ -193,7 +193,7 @@ module Gifenc
     class Application < Extension
 
       # Label identifying an Application Extension block.
-      LABEL = 0xFF
+      LABEL = "\xFF".freeze
 
       # Application identifier. Must be an 8 character ASCII string.
       # @return [String] The identifier string.