bithex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bf95c38d17be6a0a1a3c2f71935b82d1d5add9886950a0f46bea231bcb82b6c
+  data.tar.gz: ad9055a08bcc1b54ed373ca56ae19ebbd90d71d9c956c9f4fc9d8d8d678f6f10
+SHA512:
+  metadata.gz: 4273bf78339a029633f7d2904b371c094048b510dbff139245f6a8007fd3b404ec7f0d6a3ae29134049eb4512f7cf47ea0a65a9bede814983eeed8c5b3210f9a
+  data.tar.gz: 120ad8343b393a0bc4af815ea1e8a3a3c0de73bb1b58f402cf15de89ffe9188fba8c45815bedc4ae76fd878c5d871456726989eb96debf0dfa657d99c4e04251

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+sudo: required
+
+rvm:
+  - "2.5.3"
+
+cache:
+  bundler: true
+
+script: 'bundle exec rspec'

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bithex.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rustam Sharshenov
+
+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,56 @@
+# Bithex [![Build Status](https://travis-ci.org/sharshenov/bithex.svg?branch=master)](https://travis-ci.org/sharshenov/bithex) [![Gem Version](https://badge.fury.io/rb/bithex.svg)](https://badge.fury.io/rb/bithex)
+
+Store hex strings as [PostgreSQL bit strings](https://edgeguides.rubyonrails.org/active_record_postgresql.html#bit-string-types) to reduce column size 2x.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bithex'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bithex
+
+## Usage
+
+Create column
+
+```
+create_table :uploads do |t|
+  t.column :digest, "bit(160)" # For SHA1 limit is 160, for MD5 limit is 128
+end
+```
+
+Define bithex attributes
+
+```ruby
+class Upload < ActiveRecord::Base
+  bithex :digest
+
+  # if you have multiple attributes to store as bit string
+  # bithex :foo, :bar, :baz
+end
+```
+
+Treat you bithex attribute as usual string, but remember: string length is hardcoded by limit of bit column (40 for SHA1, 32 for MD5)
+
+```ruby
+upload = Upload.new
+upload.digest = Digest::SHA1.hexdigest('foo bar baz') # c7567e8b39e2428e38bf9c9226ac68de4c67dc39
+upload.save
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bithex.
+
+## 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,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bithex.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bithex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bithex'
+  spec.version       = Bithex::VERSION
+  spec.authors       = ['Rustam Sharshenov']
+  spec.email         = ['rustam@sharshenov.com']
+
+  spec.summary       = 'Store hex strings as bit strings'
+  spec.description   = 'Store hex strings as bit strings in PostgreSQL'
+  spec.homepage      = 'https://github.com/sharshenov/bithex'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/lib/bithex/active_record.rb

@@ -0,0 +1,22 @@
+module Bithex
+  # It is supposed to be included in ActiveRecord::Base
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    # Bithex attributes are defined like this:
+    #   class Upload < ActiveRecord::Base
+    #     bithex :foo, :bar, :baz
+    #   end
+    module ClassMethods
+      def bithex(*definitions)
+        definitions.each do |name|
+          attr = attribute_alias?(name) ? attribute_alias(name) : name
+
+          decorate_attribute_type(attr, :bithex) do |subtype|
+            Bithex::Type.new(attr, subtype)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bithex/type.rb

@@ -0,0 +1,59 @@
+module Bithex
+  # Serializes hex string to bit string and vice versa
+  class Type < ActiveRecord::Type::Value
+    attr_reader :attr,
+                :subtype
+
+    def initialize(attr, subtype)
+      @attr     = attr
+      @subtype  = subtype
+      validate_subtype
+    end
+
+    def deserialize(value)
+      return if value.blank?
+
+      format("%0#{hex_value_length}x", value.to_i(2))
+    end
+
+    def serialize(value)
+      return if value.blank?
+
+      [value.to_s].pack('H*').unpack1('B*')
+    end
+
+    def assert_valid_value(value)
+      return if value.blank?
+
+      validate_format(value)
+      validate_length(value)
+    end
+
+    private
+
+    def hex_value_length
+      subtype.limit / 4
+    end
+
+    def validate_subtype
+      return if subtype.is_a?(::ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Bit)
+
+      raise ::ActiveRecord::SerializationTypeMismatch,
+            "Expected '#{attr}' to be a bit string. Check DB column type."
+    end
+
+    def validate_format(value)
+      return if value.match?(/\h+/)
+
+      raise ArgumentError,
+            "Expected '#{value}' to be a hex string"
+    end
+
+    def validate_length(value)
+      return if value.to_s.length == hex_value_length
+
+      raise ArgumentError,
+            "Expected length of '#{value}' to be equal to #{hex_value_length}"
+    end
+  end
+end

data/lib/bithex/version.rb

@@ -0,0 +1,3 @@
+module Bithex
+  VERSION = '0.1.0'.freeze
+end

data/lib/bithex.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+require 'bithex/type'
+require 'bithex/active_record'
+require 'bithex/version'
+
+ActiveRecord::Base.include Bithex::ActiveRecord

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: bithex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rustam Sharshenov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Store hex strings as bit strings in PostgreSQL
+email:
+- rustam@sharshenov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bithex.gemspec
+- lib/bithex.rb
+- lib/bithex/active_record.rb
+- lib/bithex/type.rb
+- lib/bithex/version.rb
+homepage: https://github.com/sharshenov/bithex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Store hex strings as bit strings
+test_files: []