snappy-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ffcdc64cf93afdef43c64bfac7cce36f1461621f605f9663cd1e004edafc1ec
+  data.tar.gz: 83e7a4f8b1e29a476a94c9d68b317029c640b3e5c5b3d681eaf22eebe5d939f1
+SHA512:
+  metadata.gz: 3b0d9a931fcb349f1afc70726123cb06039ddf35c40ab711d2d2b32d9b6c6e986f047af1c0e928f357ef59c523d85df6eb082272ae8a41fb0a36c6144dae8561
+  data.tar.gz: e98f7b827e8884dcbac00dcdd6cc96cbf02924962eee69bb767b2b18c7b4f8dfd6a7b88dfd8effaa9b1f78ad1b6200663dfa37a50bad7e36a39be9867a8fc4b1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 snappy-ruby
+
+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,77 @@
+# Snappy Ruby Bindings
+
+Ruby bindings for Google's Snappy compression library (https://github.com/google/snappy) with **bundled libsnappy source** - no system dependencies required!
+
+## Features
+
+- Fast compression and decompression using Snappy
+- **Bundled Snappy library** - no need to install libsnappy separately
+- File-based compression/decompression with input and output filename support
+- Compression level support (compatible with Snappy's range: 1-9)
+- Compatible with Ruby 3.0+
+- Works on Linux, macOS, and Windows
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snappy-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install snappy-ruby
+
+## Usage
+
+```ruby
+require 'snappy'
+
+# Compress data from a file
+Snappy.compress_file('input.txt', 'output.snappy', level: 6)
+
+# Decompress data to a file
+Snappy.decompress_file('output.snappy', 'decompressed.txt')
+
+# In-memory compression/decompression
+compressed = Snappy.compress('Hello, World!', level: 6)
+decompressed = Snappy.decompress(compressed)
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Requirements
+
+- Ruby 3.0 or higher
+- Ruby development headers (ruby-dev)
+- C++ compiler with C++11 support
+
+**Note:** The Snappy library is bundled with this gem, so you don't need to install libsnappy separately!
+
+### Installing Build Dependencies
+
+On Ubuntu/Debian:
+```bash
+sudo apt-get install ruby-dev build-essential
+```
+
+On macOS (requires Xcode Command Line Tools):
+```bash
+xcode-select --install
+```
+
+On Fedora/RHEL:
+```bash
+sudo dnf install ruby-devel gcc-c++ make
+```
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rake/extensiontask"
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::ExtensionTask.new("snappy") do |ext|
+  ext.lib_dir = "lib/snappy"
+end
+
+task default: [:compile, :spec]
+task spec: :compile

data/ext/snappy/extconf.rb

@@ -0,0 +1,83 @@
+require "mkmf"
+
+# Configuration for bundled Snappy library
+SNAPPY_DIR = File.expand_path("snappy-src", __dir__)
+
+unless File.directory?(SNAPPY_DIR)
+  abort <<-ERROR
+
+  ERROR: Snappy source directory not found at #{SNAPPY_DIR}
+
+  The Snappy library source should be bundled with this gem.
+  Please ensure the gem was installed correctly.
+
+  ERROR
+end
+
+# Add Snappy source directory to include path
+$INCFLAGS << " -I#{SNAPPY_DIR}"
+
+# Add C++11 support (required by Snappy)
+$CXXFLAGS << " -std=c++11 -fno-exceptions -fno-rtti"
+
+# Link against C++ standard library
+$LIBS << " -lstdc++"
+
+# Define HAVE_CONFIG_H to use our config.h
+$CPPFLAGS << " -DHAVE_CONFIG_H"
+
+# Disable some warnings for cleaner output
+$CXXFLAGS << " -Wno-sign-compare"
+
+# Create a symlink for snappy.cc with a different name to avoid conflict with snappy.c
+# The Ruby binding (snappy.c) will compile to snappy.o
+# The Snappy library (snappy-lib.cc) will compile to snappy-lib.o
+snappy_lib_link = File.join(SNAPPY_DIR, "snappy-lib.cc")
+snappy_lib_src = File.join(SNAPPY_DIR, "snappy.cc")
+
+# Remove old symlink if it exists, then create new one
+File.delete(snappy_lib_link) if File.exist?(snappy_lib_link) || File.symlink?(snappy_lib_link)
+File.symlink("snappy.cc", snappy_lib_link)
+
+# List of Snappy source files to compile
+snappy_sources = %w[
+  snappy-lib.cc
+  snappy-c.cc
+  snappy-sinksource.cc
+  snappy-stubs-internal.cc
+]
+
+# Add VPATH to tell make where to find the source files
+$VPATH ||= []
+$VPATH << SNAPPY_DIR
+
+# Initialize $objs if it's not already initialized
+$objs ||= []
+
+# First, add the main Ruby binding (snappy.c -> snappy.o)
+# This file is in ext/snappy/, not in snappy-src/
+$objs << "snappy.o"
+
+# Add Snappy library source files
+snappy_sources.each do |src|
+  $objs << src.sub(/\.cc$/, ".o")
+end
+
+# Verify all required source files exist
+missing_files = snappy_sources.reject { |src| File.exist?(File.join(SNAPPY_DIR, src)) || File.symlink?(File.join(SNAPPY_DIR, src)) }
+unless missing_files.empty?
+  abort "ERROR: Missing Snappy source files:\n  #{missing_files.join("\n  ")}"
+end
+
+puts "=" * 70
+puts "Building snappy-ruby with bundled Snappy library"
+puts "=" * 70
+puts "Snappy source: #{SNAPPY_DIR}"
+puts "Include flags: #{$INCFLAGS}"
+puts "C++ flags: #{$CXXFLAGS}"
+puts "Main Ruby binding: snappy.c"
+puts "Compiling Snappy sources:"
+snappy_sources.each { |src| puts "  - #{src}" }
+puts "=" * 70
+
+create_makefile("snappy/snappy")

data/ext/snappy/snappy-src/AUTHORS

@@ -0,0 +1 @@
+opensource@google.com

data/ext/snappy/snappy-src/BUILD.bazel

@@ -0,0 +1,211 @@
+# Copyright 2023 Google Inc. All Rights Reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+package(default_visibility = ["//visibility:public"])
+
+licenses(["notice"])
+
+SNAPPY_VERSION = (1, 2, 2)
+
+config_setting(
+    name = "windows",
+    constraint_values = ["@platforms//os:windows"],
+)
+
+cc_library(
+    name = "config",
+    hdrs = ["config.h"],
+    defines = ["HAVE_CONFIG_H"],
+)
+
+cc_library(
+    name = "snappy-stubs-public",
+    hdrs = [":snappy-stubs-public.h"],
+)
+
+cc_library(
+    name = "snappy-stubs-internal",
+    srcs = ["snappy-stubs-internal.cc"],
+    hdrs = ["snappy-stubs-internal.h"],
+    deps = [
+        ":config",
+        ":snappy-stubs-public",
+    ],
+)
+
+cc_library(
+    name = "snappy",
+    srcs = [
+        "snappy.cc",
+        "snappy-internal.h",
+        "snappy-sinksource.cc",
+    ],
+    hdrs = [
+        "snappy.h",
+        "snappy-sinksource.h",
+    ],
+    copts = select({
+        ":windows": [],
+        "//conditions:default": [
+            "-Wno-sign-compare",
+        ],
+    }),
+    deps = [
+        ":config",
+        ":snappy-stubs-internal",
+        ":snappy-stubs-public",
+    ],
+)
+
+cc_library(
+    name = "snappy-c",
+    srcs = ["snappy-c.cc"],
+    hdrs = ["snappy-c.h"],
+    deps = [":snappy"],
+)
+
+filegroup(
+    name = "testdata",
+    srcs = glob(["testdata/*"]),
+)
+
+cc_library(
+    name = "snappy-test",
+    testonly = True,
+    srcs = [
+        "snappy-test.cc",
+        "snappy_test_data.cc",
+    ],
+    hdrs = [
+        "snappy-test.h",
+        "snappy_test_data.h",
+    ],
+    deps = [":snappy-stubs-internal"],
+)
+
+cc_test(
+    name = "snappy_benchmark",
+    srcs = ["snappy_benchmark.cc"],
+    data = [":testdata"],
+    deps = [
+        ":snappy",
+        ":snappy-test",
+        "@com_google_benchmark//:benchmark_main",
+    ],
+)
+
+cc_test(
+    name = "snappy_unittest",
+    srcs = [
+        "snappy_unittest.cc",
+    ],
+    data = [":testdata"],
+    deps = [
+        ":snappy",
+        ":snappy-test",
+        "@com_google_googletest//:gtest_main",
+    ],
+)
+
+# Generate a config.h similar to what cmake would produce.
+genrule(
+    name = "config_h",
+    outs = ["config.h"],
+    cmd = """cat <<EOF >$@
+#define HAVE_STDDEF_H 1
+#define HAVE_STDINT_H 1
+#ifdef __has_builtin
+#  if !defined(HAVE_BUILTIN_EXPECT) && __has_builtin(__builtin_expect)
+#    define HAVE_BUILTIN_EXPECT 1
+#  endif
+#  if !defined(HAVE_BUILTIN_CTZ) && __has_builtin(__builtin_ctzll)
+#    define HAVE_BUILTIN_CTZ 1
+#  endif
+#  if !defined(HAVE_BUILTIN_PREFETCH) && __has_builtin(__builtin_prefetech)
+#    define HAVE_BUILTIN_PREFETCH 1
+#  endif
+#elif defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ >= 4)
+#  ifndef HAVE_BUILTIN_EXPECT
+#    define HAVE_BUILTIN_EXPECT 1
+#  endif
+#  ifndef HAVE_BUILTIN_CTZ
+#    define HAVE_BUILTIN_CTZ 1
+#  endif
+#  ifndef HAVE_BUILTIN_PREFETCH
+#    define HAVE_BUILTIN_PREFETCH 1
+#  endif
+#endif
+
+#if defined(_WIN32) && !defined(HAVE_WINDOWS_H)
+#define HAVE_WINDOWS_H 1
+#endif
+
+#ifdef __has_include
+#  if !defined(HAVE_BYTESWAP_H) && __has_include(<byteswap.h>)
+#    define HAVE_BYTESWAP_H 1
+#  endif
+#  if !defined(HAVE_UNISTD_H) && __has_include(<unistd.h>)
+#    define HAVE_UNISTD_H 1
+#  endif
+#  if !defined(HAVE_SYS_ENDIAN_H) && __has_include(<sys/endian.h>)
+#    define HAVE_SYS_ENDIAN_H 1
+#  endif
+#  if !defined(HAVE_SYS_MMAN_H) && __has_include(<sys/mman.h>)
+#    define HAVE_SYS_MMAN_H 1
+#  endif
+#  if !defined(HAVE_SYS_UIO_H) && __has_include(<sys/uio.h>)
+#    define HAVE_SYS_UIO_H 1
+#  endif
+#  if !defined(HAVE_SYS_TIME_H) && __has_include(<sys/time.h>)
+#    define HAVE_SYS_TIME_H 1
+#  endif
+#endif
+
+#ifndef SNAPPY_IS_BIG_ENDIAN
+#  ifdef __s390x__
+#    define SNAPPY_IS_BIG_ENDIAN 1
+#  elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+#    define SNAPPY_IS_BIG_ENDIAN 1
+#  endif
+#endif
+EOF
+""",
+)
+
+genrule(
+    name = "snappy_stubs_public_h",
+    srcs = ["snappy-stubs-public.h.in"],
+    outs = ["snappy-stubs-public.h"],
+    # Assume sys/uio.h is available on non-Windows.
+    # Set the version numbers.
+    cmd = ("""sed -e 's/$${HAVE_SYS_UIO_H_01}/!_WIN32/g' \
+           -e 's/$${PROJECT_VERSION_MAJOR}/%d/g' \
+           -e 's/$${PROJECT_VERSION_MINOR}/%d/g' \
+           -e 's/$${PROJECT_VERSION_PATCH}/%d/g' \
+    $< >$@""" % SNAPPY_VERSION),
+)