oss-ar 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79aec43def861f705ca99fba23e6272e42beb2285c26c0eb8e49fe1b000ef954
-  data.tar.gz: 4a9d2644fb91513fc45fe10c93d8d6ce3d66afac4c36c12f6b4b8af36681f4d2
+  metadata.gz: 22fb8bd93da07f822d96b4f40458ca5607bc3f66a2cbfd5718689921b40a2bb2
+  data.tar.gz: 916d873fdc394dafe551c93aaf442adf81c08a96bc57c95d93e43d93295cb9ed
 SHA512:
-  metadata.gz: b870eb437f04415281f9258511234da6d5b71b2fc1de5a414c678ee5e1752ee7aab98facd3beb59db7edf6830a0a83f0e2d66822e94263bc8aad07c55436eaf4
-  data.tar.gz: 62e94d621972d750cba9f201415911dce13d3e83baaf24ec71bc8a649e0b52d6e9d3669b14c12b17cdbf136cc7b3ab85effbaa32604ab0e8b5e59280298e6414
+  metadata.gz: d181d757a2dc241f8d36e492c8b6da2b0c36c819459f2a6f7d17b0c2fa17d77a6ebcc2139c424ddbb9a8b9f32c20ca50bb880877cb92f262174d15065b4e269f
+  data.tar.gz: 6526516e5afabdcdf110817c8ee358e1d7c41bea31c26aa322c91e5affe4eebb4375aa5831578377bc7141717ab7b5abd8a007a2190b55f1babc77e3ff703f2c

data/lib/oss-activerecord/attachment.rb

@@ -7,6 +7,7 @@ module OSS
     extend T::Sig
 
     self.primary_key = :object_key
+    self.table_name = 'oss_attachments'
 
     validates :object_key, presence: true, uniqueness: { scope: %i[attachable_id attachable_type context] }
 

data/lib/oss-activerecord/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OSS
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/oss-activerecord.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
 require 'sorbet-runtime'
+require_relative 'oss-activerecord/version'
 require_relative "oss-activerecord/attachment"
-
-module Meta
-  module OSS
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oss-ar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - yetrun
@@ -9,7 +9,21 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2024-05-06 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description:
 email:
 - yetrun@foxmail.com
@@ -17,11 +31,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- Gemfile
-- Gemfile.lock
-- README.md
-- Rakefile
 - lib/oss-activerecord.rb
 - lib/oss-activerecord/attachment.rb
 - lib/oss-activerecord/version.rb

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/Gemfile

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in oss-activerecord.gemspec
-gemspec
-
-group :development do
-  gem "rake", "~> 13.0"
-end
-
-group :test do
-  gem "rspec", "~> 3.0"
-end
-
-gem "activerecord", "~> 7.1"
-gem "sqlite3", "~> 1.4"
-gem "sorbet-runtime", "~> 0.5.11357"
-
-gem "aliyun-sdk", "~> 0.8.0"
-gem "qiniu", "~> 6.9"

data/Gemfile.lock

@@ -1,93 +0,0 @@
-PATH
-  remote: .
-  specs:
-    oss-ar (0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (7.1.3.2)
-      activesupport (= 7.1.3.2)
-    activerecord (7.1.3.2)
-      activemodel (= 7.1.3.2)
-      activesupport (= 7.1.3.2)
-      timeout (>= 0.4.0)
-    activesupport (7.1.3.2)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    aliyun-sdk (0.8.0)
-      nokogiri (~> 1.6)
-      rest-client (~> 2.0)
-    base64 (0.2.0)
-    bigdecimal (3.1.7)
-    concurrent-ruby (1.2.3)
-    connection_pool (2.4.1)
-    diff-lcs (1.5.1)
-    domain_name (0.6.20240107)
-    drb (2.2.1)
-    http-accept (1.7.0)
-    http-cookie (1.0.5)
-      domain_name (~> 0.5)
-    i18n (1.14.4)
-      concurrent-ruby (~> 1.0)
-    mime-types (3.5.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2024.0305)
-    minitest (5.22.3)
-    mutex_m (0.2.0)
-    netrc (0.11.0)
-    nokogiri (1.16.4-x86_64-darwin)
-      racc (~> 1.4)
-    qiniu (6.9.1)
-      mime-types (~> 3.1)
-      rest-client (~> 2.0)
-      rexml (~> 3.2)
-    racc (1.7.3)
-    rake (13.2.1)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rexml (3.2.6)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    sorbet-runtime (0.5.11357)
-    sqlite3 (1.7.3-x86_64-darwin)
-    timeout (0.4.1)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-
-PLATFORMS
-  x86_64-darwin-22
-
-DEPENDENCIES
-  activerecord (~> 7.1)
-  aliyun-sdk (~> 0.8.0)
-  oss-ar!
-  qiniu (~> 6.9)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  sorbet-runtime (~> 0.5.11357)
-  sqlite3 (~> 1.4)
-
-BUNDLED WITH
-   2.4.6

data/README.md

@@ -1,171 +0,0 @@
-# oss-activerecord
-
-一种用于将国内的云存储服务与 ActiveRecord 集成的解决方案。
-
-## 写在最前
-
-该 gem 主要包括两个部分：
-
-1. 一个 OSS 服务的适配器，将不同的 OSS 服务抽象为统一的接口，方便在不同的 OSS 服务商之间切换。
-2. 一个 OSS::Attachment 数据表，将 OSS 上传的对象纳入在一个表中管理，方便日后的迁移。
-
-## 安装
-
-在 Gemfile 中添加：
-
-```ruby
-gem 'oss-activerecord'
-```
-
-然后执行：
-
-```bash
-$ bundle
-```
-
-最后在 Ruby 项目中引入：
-
-```ruby
-require 'oss-activerecord'
-```
-
-## OSS Adapter
-
-没有为 OSS Adapter 提供一个统一的类，而是提供不同的云厂商的适配器，你可以根据自己的需求选择合适的适配器。（这么做是因为 Ruby 语言不需要）
-
-目前已支持的 OSS 服务商有：
-
-- 阿里云 OSS：`OSS::Adapters::AliyunAdapter`
-- 七牛云 OSS：`OSS::Adapters::QiniuAdapter`
-
-### 创建 adapter
-
-创建遵从相同的接口签名，以阿里云 OSS 为例：
-
-```ruby
-gem "aliyun-sdk"
-
-require 'oss/adapters/aliyun_adapter'
-adapter = OSS::Adapters::AliyunAdapter.new(
-  access_key: 'your-access-key-id',
-  secret_key: 'your-access-key-secret',
-  endpoint: 'your-endpoint',
-  bucket: 'your-bucket'
-)
-```
-
-以七牛云 OSS 为例：
-
-```ruby
-gem "qiniu"
-
-require 'oss/adapters/qiniu_adapter'
-adapter = OSS::Adapters::QiniuAdapter.new(
-  access_key: 'your-access-key',
-  secret_key: 'your-secret-key',
-  endpoint: 'your-endpoint',
-  bucket: 'your-bucket'
-)
-```
-
-### 上传文件
-
-```ruby
-adapter.upload('path/to/file', 'object-key')
-```
-
-### 返回签名 URL
-
-```ruby
-adapter.signed_url('object-key')
-```
-
-## `OSS::Attachment`
-
-该模块主要是将所有与云存储对象相关的属性都关联一个表，方便统一管理和日后的迁移。同时，为了维护项目本身的兼容性，也为了适应更常见的需求，该模块将表关联的操作透明化。
-
-### 创建表
-
-在使用该模块之前，要求系统中已经存在一个 `oss_attachments` 表，类似的迁移脚本：
-
-```ruby
-create_table :attachments do |t|
-  t.string :object_key, comment: 'OSS 对象的 key'
-  t.references :attachable, polymorphic: true, comment: '关联的对象'
-  t.string :context, comment: '属性上下文'
-end
-```
-
-### 关联模型
-
-以 `User` 模型为例：
-
-```ruby
-class User < ActiveRecord::Base
-  extend OSS::Attachment::Attachable
-  
-  has_one_attached :avatar, :avatar_url
-end
-```
-
-该动作创建了一个 `avatar` 关联，同时创建了一个 `avatar_url` 的属性用于兼容性操作。
-
-### 使用属性 URL
-
-```ruby
-user = User.new
-
-# 保存 URL
-user.avatar_url = 'object_key' # or full url、full url with signature
-user.save! # 这一步才会写入数据库
-
-# 读取 URL
-user.avatar_url # get full url
-```
-
-### has_many_attached
-
-除了 `has_one_attached` 之外，还支持 `has_many_attached`：
-
-```ruby
-class User < ActiveRecord::Base
-  extend OSS::Attachment::Attachable
-  
-  has_many_attached :photos, :photo_urls
-end
-```
-
-此时可以使用 `photo_urls` 进行操作。
-
-```ruby
-user = User.new
-
-# 保存 URL
-user.photo_urls = ['object_key1', 'object_key2'] # or full urls、full urls with signature
-user.save! # 这一步才会写入数据库
-
-# 读取 URL
-user.photo_urls # get full urls
-```
-
-## 开发
-
-```bash
-git clone 本仓库
-
-# 安装依赖项目
-bundle
-
-# 运行单元测试
-bundle exec rspec
-
-# 生成 gem
-gem build oss-activerecord.gemspec
-
-# 推送 gem
-gem push oss-activerecord-x.x.x.gem
-```
-
-## 贡献
-
-问题报告和 pull requests 在 GitHub 上：https://github.com/[USERNAME]/meta-oss.

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec