twenty-backend 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98b68e3768a220ad9a15cb7463606be7ceecd9ec724050a70fadfc1aa598e20b
-  data.tar.gz: 3c25ca218e14184a5dc37012e252b8712c0485aeab6f25cfe0e32e9bad212b48
+  metadata.gz: 67194d6fb4501a193b1b8afcdc47262fa17733e7b3a569a858e8055e65d63841
+  data.tar.gz: 29ce99129bc682c0cb3713c2c7baaf91647cff4d999fbe4587d362a5e19e16b0
 SHA512:
-  metadata.gz: c6dc81bc79b91423c1829ecc9344e0d4b7cdf5391323be40d87db0649d9ba75e5290848ebdb5a4914f53b8758f92d19a1493ea1a388befb00d5295eb8086f93a
-  data.tar.gz: 51cfd7a902aa38b6123750c9927dd14eaa3b26bfdc11edfb3bdd34e8e540ce8f20b3c40b9cf067e49058e629d37cb0fec61c0faa72393c32676245e6ea544696
+  metadata.gz: 256f82f48191c084384bee5f369921214a5634460e4f30298bda66f788b4f3f619419959a5a95d37d4c78f537e9ae013cb47e839be13dd8351d8e79abc01b847
+  data.tar.gz: 5d4c458aee402d670b9d64b6cb01a97d2d0e9ec2f4b371d5f52dab5c407fef2f1380f8f6d5d75798fd8155822e72370753779412a8cb3235a12d7b6af3192e4f

data/lib/twenty-backend/graphql/input/task_input.rb

@@ -0,0 +1,9 @@
+module Twenty::GraphQL::Input
+  class TaskInput < GraphQL::Schema::InputObject
+    require_relative "../type/task_status"
+    argument :title, String, required: false
+    argument :content, String, required: false
+    argument :project_id, Int, required: false
+    argument :status, Twenty::GraphQL::Type::TaskStatus, required: false
+  end
+end

data/lib/twenty-backend/graphql/input.rb

@@ -0,0 +1,4 @@
+module Twenty::GraphQL::Input
+  include GraphQL::Types
+  require_relative "input/task_input"
+end

data/lib/twenty-backend/graphql/mutation/complete_task.rb

@@ -0,0 +1,15 @@
+module Twenty::GraphQL::Mutation
+  class CompleteTask < GraphQL::Schema::Mutation
+    argument :task_id, Int
+    field :ok, Boolean
+    field :errors, [String]
+
+    def resolve(task_id:)
+      task = Twenty::Task.find(task_id)
+      task.update!(status: :complete)
+      {ok: true, errors: []}
+    rescue => ex
+      {ok: false, errors: [ex.message]}
+    end
+  end
+end

data/lib/twenty-backend/graphql/mutation/create_task.rb

@@ -0,0 +1,13 @@
+module Twenty::GraphQL::Mutation
+  class CreateTask < GraphQL::Schema::Mutation
+    field :errors, [String], null: false
+    argument :input, Twenty::GraphQL::Input::TaskInput
+
+    def resolve(input:)
+      Twenty::Task.new(input.to_h).save!
+      {"errors" => []}
+    rescue => ex
+      {"errors" => [ex.message]}
+    end
+  end
+end

data/lib/twenty-backend/graphql/mutation/destroy_task.rb

@@ -0,0 +1,15 @@
+module Twenty::GraphQL::Mutation
+  class DestroyTask < GraphQL::Schema::Mutation
+    argument :task_id, Int
+    field :ok, Boolean
+    field :errors, [String]
+
+    def resolve(task_id:)
+      task = Twenty::Task.find(task_id)
+      task.destroy!
+      {ok: true, errors: []}
+    rescue => ex
+      {ok: false, errors: [ex.message]}
+    end
+  end
+end

data/lib/twenty-backend/graphql/mutation/set_random_project_color.rb

@@ -0,0 +1,17 @@
+module Twenty::GraphQL::Mutation
+  class SetRandomProjectColor < ::GraphQL::Schema::Mutation
+    require_relative "../type/project"
+    argument :project_id, Int, required: true
+
+    field :errors, [String], null: false
+    field :project, Twenty::GraphQL::Type::Project, null: true
+
+    def resolve(project_id:)
+      project = Twenty::Project.find(project_id)
+      project.update!(color: project.random_color)
+      {errors: [], project:}
+    rescue => ex
+      {errors: [ex.message]}
+    end
+  end
+end

data/lib/twenty-backend/graphql/mutation/update_task.rb

@@ -0,0 +1,15 @@
+module Twenty::GraphQL::Mutation
+  class UpdateTask < GraphQL::Schema::Mutation
+    field :errors, [String], null: false
+    argument :task_id, Int
+    argument :input, Twenty::GraphQL::Input::TaskInput
+
+    def resolve(task_id:, input:)
+      task = Twenty::Task.find_by(id: task_id)
+      task.update!(input.to_h)
+      {"errors" => []}
+    rescue => ex
+      {"errors" => [ex.message]}
+    end
+  end
+end

data/lib/twenty-backend/graphql/mutation.rb

@@ -0,0 +1,5 @@
+module Twenty::GraphQL
+  module Mutation
+    require_relative "mutation/destroy_task"
+  end
+end

data/lib/twenty-backend/graphql/schema.rb

@@ -0,0 +1,6 @@
+module Twenty::GraphQL
+  class Schema < GraphQL::Schema
+    query Type::Query
+    mutation Type::Mutation
+  end
+end

data/lib/twenty-backend/graphql/type/mutation.rb

@@ -0,0 +1,14 @@
+module Twenty::GraphQL::Type
+  class Mutation < GraphQL::Schema::Object
+    require_relative "../mutation/destroy_task"
+    require_relative "../mutation/complete_task"
+    require_relative "../mutation/create_task"
+    require_relative "../mutation/update_task"
+    require_relative "../mutation/set_random_project_color"
+    field :destroy_task, mutation: Twenty::GraphQL::Mutation::DestroyTask
+    field :complete_task, mutation: Twenty::GraphQL::Mutation::CompleteTask
+    field :create_task, mutation: Twenty::GraphQL::Mutation::CreateTask
+    field :update_task, mutation: Twenty::GraphQL::Mutation::UpdateTask
+    field :set_random_project_color, mutation: Twenty::GraphQL::Mutation::SetRandomProjectColor
+  end
+end

data/lib/twenty-backend/graphql/type/project.rb

@@ -0,0 +1,10 @@
+module Twenty::GraphQL::Type
+  class Project < GraphQL::Schema::Object
+    require_relative "task"
+    field :id, Int, null: false
+    field :name, String, null: false
+    field :path, String, null: false
+    field :color, String, null: false
+    field :tasks, [Task], null: false
+  end
+end

data/lib/twenty-backend/graphql/type/query.rb

@@ -0,0 +1,27 @@
+module Twenty::GraphQL::Type
+  class Query < GraphQL::Schema::Object
+    field :find_task, Task, null: true do
+      argument :task_id, Int
+    end
+    field :tasks, [Task], null: false do
+      argument :status, TaskStatus
+      argument :project_id, Int, required: false
+    end
+    field :projects, [Project], null: false
+
+    def find_task(task_id:)
+      Twenty::Task.find_by(id: task_id)
+    end
+
+    def tasks(status:, project_id: nil)
+      tasks = Twenty::Task
+        .where(status:)
+        .order(updated_at: :desc)
+      project_id ? tasks.where(project_id:) : tasks
+    end
+
+    def projects
+      Twenty::Project.all
+    end
+  end
+end

data/lib/twenty-backend/graphql/type/task.rb

@@ -0,0 +1,15 @@
+module Twenty::GraphQL::Type
+  class Task < GraphQL::Schema::Object
+    require_relative "project"
+    field :id, Int, null: false
+    field :title, String, null: false
+    field :status, TaskStatus, null: false
+    field :content, String, null: false
+    field :project, Project, null: false
+    field :updated_at, GraphQL::Types::ISO8601DateTime, null: false
+    field :is_ready, Boolean, null: false, method: :ready?
+    field :is_backlogged, Boolean, null: false, method: :backlog?
+    field :is_complete, Boolean, null: false, method: :complete?
+    field :in_progress, Boolean, null: false, method: :in_progress?
+  end
+end

data/lib/twenty-backend/graphql/type/task_status.rb

@@ -0,0 +1,8 @@
+module Twenty::GraphQL::Type
+  class TaskStatus < GraphQL::Schema::Enum
+    value :backlog
+    value :ready
+    value :in_progress
+    value :complete
+  end
+end

data/lib/twenty-backend/graphql/type.rb

@@ -0,0 +1,10 @@
+module Twenty::GraphQL
+  module Type
+    include ::GraphQL::Types
+  end
+  require_relative "type/task_status"
+  require_relative "type/project"
+  require_relative "type/task"
+  require_relative "type/query"
+  require_relative "type/mutation"
+end

data/lib/twenty-backend/graphql.rb

@@ -0,0 +1,7 @@
+module Twenty::GraphQL
+  require "graphql"
+  require_relative "graphql/input"
+  require_relative "graphql/type"
+  require_relative "graphql/mutation"
+  require_relative "graphql/schema"
+end

data/lib/twenty-backend/migration/1_create_projects.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateProjects < ActiveRecord::Migration[7.1]
+  def up
+    create_table(:projects) do |t|
+      t.string :name, null: false
+      t.string :path, null: false
+      t.timestamps
+    end
+    add_index :projects, [:name, :path], unique: true
+  end
+
+  def down
+    drop_table(:projects)
+  end
+end

data/lib/twenty-backend/migration/2_create_tasks.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateTasks < ActiveRecord::Migration[7.1]
+  def up
+    create_table(:tasks) do |t|
+      t.string :title, null: false
+      t.text :content, null: false
+      t.integer :status, null: false, default: 0
+      t.belongs_to :project, null: false
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table(:tasks)
+  end
+end

data/lib/twenty-backend/migration/3_add_color_to_projects.rb

@@ -0,0 +1,10 @@
+class AddColorToProjects < ActiveRecord::Migration[7.1]
+  def up
+    default = Twenty::ColorableMixin.random_color
+    add_column :projects, :color, :string, null: false, default:
+  end
+
+  def down
+    drop_column :projects, :color
+  end
+end

data/lib/twenty-backend/migration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Twenty::Migration
+  ##
+  # @return [String]
+  #  Returns the path to twenty's migrations.
+  def self.migrations_path
+    [File.join(__dir__, "migration")]
+  end
+
+  ##
+  # Runs migrations (if neccessary).
+  # @return [void]
+  def self.run!
+    context.migrate
+  end
+  ActiveRecord.timestamped_migrations = false
+
+  ##
+  # @return [Boolean]
+  #  Returns true when there are pending migrations.
+  def self.pending_migrations?
+    context.open.pending_migrations.any?
+  end
+
+  ##
+  # @return [ActiveRecord::MigrationContext]
+  #  Returns an instance of
+  #  {ActiveRecord::MigrationContext ActiveRecord::MigrationContext}.
+  def self.context
+    @context ||= ActiveRecord::MigrationContext.new(migrations_path)
+  end
+  private_class_method :context
+end

data/lib/twenty-backend/model/mixin/colorable_mixin.rb

@@ -0,0 +1,28 @@
+module Twenty::ColorableMixin
+  extend self
+
+  COLORS = [
+    '#222222', '#333333', '#444444', '#555555', '#666666',
+    '#777777', '#888888', '#999999', '#AA2222', '#22AA22',
+    '#2222AA', '#AA22AA', '#CC9900', '#0099CC', '#9900CC',
+    '#FF9900', '#00CC99', '#99CC00', '#CC0099', '#990000',
+    '#112233', '#445566', '#778899', '#AA4455', '#5544AA',
+    '#88AA44', '#AA88AA', '#CCBB00', '#1155CC', '#9900BB',
+    '#DD6600', '#00BBCC', '#CC0099', '#BB3300', '#006688',
+    '#993366', '#2200AA', '#557788', '#998877', '#BB4400'
+  ]
+
+  def self.included(klass)
+    klass.before_validation :set_random_color, on: :create
+  end
+
+  def random_color
+    COLORS.sample
+  end
+
+  private
+
+  def set_random_color
+    self.color = random_color
+  end
+end

data/lib/twenty-backend/model/project.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Twenty::Project < Twenty::Model
+  include Twenty::ColorableMixin
+  self.table_name = "projects"
+
+  ##
+  # Validations
+  validates :name, presence: true
+  validates :path, presence: true
+
+  ##
+  # Associations
+  has_many :tasks, class_name: "Twenty::Task"
+
+  ##
+  # @return [String]
+  #  The path to a project.
+  def path
+    super&.sub(Dir.home, "~")
+  end
+end

data/lib/twenty-backend/model/task.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Twenty::Task < Twenty::Model
+  self.table_name = "tasks"
+
+  STATUS = {backlog: 0, ready: 1, in_progress: 2, complete: 3}
+  enum :status, STATUS, default: :backlog
+
+  ##
+  # Validations
+  validates :title, presence: true
+  validates :content, presence: true
+  validates :project, presence: true
+
+  ##
+  # Associations
+  belongs_to :project, class_name: "Twenty::Project"
+end

data/lib/twenty-backend/model.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Twenty::Model < ActiveRecord::Base
+  require_relative "model/mixin/colorable_mixin"
+  require_relative "model/project"
+  require_relative "model/task"
+end

data/lib/twenty-backend/servlet/graphql.rb

@@ -0,0 +1,15 @@
+class Twenty::Servlet::GraphQL < Twenty::Servlet
+  ##
+  # POST /servlet/graphql/
+  def do_POST(req, res)
+    params = JSON.parse(req.body)
+    result = Twenty::GraphQL::Schema.execute(
+      params['query'],
+      variables: params['variables'],
+      context: {}
+    )
+    res['content_type'] = 'application/json'
+    res.status = 200
+    res.body = result.to_json
+  end
+end

data/lib/twenty-backend/servlet/mixin/server_mixin.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Twenty::Servlet::ServerMixin
+  ##
+  # @param [Hash] options
+  #  Server options that take precedence over
+  #  {ServerMixin#server_options ServerMixin#server_options}.
+  #
+  # @return [WEBrick::HTTPServer]
+  #  Returns an instance of WEBrick::HTTPServer.
+  def server(options = {})
+    server = WEBrick::HTTPServer.new server_options.merge(options)
+    server.mount "/graphql", Twenty::Servlet::GraphQL
+    server
+  end
+
+  ##
+  # @return [Hash<Symbol, String>]
+  #  The default server options given to WEBrick::HTTPServer.new.
+  def server_options
+    {
+      DocumentRoot: Twenty.build,
+      BindAddress: "127.0.0.1",
+      Port: 2020
+    }
+  end
+end

data/lib/twenty-backend/servlet.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Twenty::Servlet < WEBrick::HTTPServlet::AbstractServlet
+  ##
+  # servlets
+  require_relative "servlet/graphql"
+
+  ##
+  # mixins
+  require_relative "servlet/mixin/server_mixin"
+  extend ServerMixin
+end

data/lib/twenty-backend.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Twenty
+  require "fileutils"
+  require "webrick"
+  require "active_record"
+  require_relative "twenty-backend/graphql"
+  require_relative "twenty-backend/servlet"
+  require_relative "twenty-backend/migration"
+  require_relative "twenty-backend/model"
+  extend FileUtils
+
+  ##
+  # @return [String]
+  #  Returns the directory where twenty stores data.
+  def self.data_dir
+    File.join(Dir.home, ".local", "share", "20")
+  end
+
+  ##
+  # @return [String]
+  #  Returns the location of the default SQLite database.
+  def self.default_database
+    @default_database ||= File.join(data_dir, "database.sqlite")
+  end
+
+  ##
+  # Establishes a database connection.
+  #
+  # @param [String] path
+  #  The path to a SQLite3 database file.
+  #
+  # @return [void]
+  def self.establish_connection(path:)
+    ActiveRecord::Base.establish_connection(
+      adapter: "sqlite3",
+      database: path,
+      pool: 16
+    )
+  end
+
+  ##
+  # Prepares the parent directory of the database.
+  # @return [void]
+  # @api private
+  def self.prepare_dir
+    return if File.exist?(default_database)
+    mkdir_p(data_dir)
+    touch(default_database)
+  rescue => ex
+    warn "prepare_dir error: #{ex.message} (#{ex.class})"
+  end
+  private_class_method :prepare_dir
+  prepare_dir
+end

data/share/twenty-backend/schema.graphql

@@ -0,0 +1,91 @@
+"""
+Autogenerated return type of CompleteTask.
+"""
+type CompleteTaskPayload {
+  errors: [String!]
+  ok: Boolean
+}
+
+"""
+Autogenerated return type of CreateTask.
+"""
+type CreateTaskPayload {
+  errors: [String!]!
+}
+
+"""
+Autogenerated return type of DestroyTask.
+"""
+type DestroyTaskPayload {
+  errors: [String!]
+  ok: Boolean
+}
+
+"""
+An ISO 8601-encoded datetime
+"""
+scalar ISO8601DateTime @specifiedBy(url: "https://tools.ietf.org/html/rfc3339")
+
+type Mutation {
+  completeTask(taskId: Int!): CompleteTaskPayload
+  createTask(input: TaskInput!): CreateTaskPayload
+  destroyTask(taskId: Int!): DestroyTaskPayload
+  setRandomProjectColor(projectId: Int!): SetRandomProjectColorPayload
+  updateTask(input: TaskInput!, taskId: Int!): UpdateTaskPayload
+}
+
+type Project {
+  color: String!
+  id: Int!
+  name: String!
+  path: String!
+  tasks: [Task!]!
+}
+
+type Query {
+  findTask(taskId: Int!): Task
+  projects: [Project!]!
+  tasks(projectId: Int, status: TaskStatus!): [Task!]!
+}
+
+"""
+Autogenerated return type of SetRandomProjectColor.
+"""
+type SetRandomProjectColorPayload {
+  errors: [String!]!
+  project: Project
+}
+
+type Task {
+  content: String!
+  id: Int!
+  inProgress: Boolean!
+  isBacklogged: Boolean!
+  isComplete: Boolean!
+  isReady: Boolean!
+  project: Project!
+  status: TaskStatus!
+  title: String!
+  updatedAt: ISO8601DateTime!
+}
+
+input TaskInput {
+  content: String
+  projectId: Int
+  status: TaskStatus
+  title: String
+}
+
+enum TaskStatus {
+  backlog
+  complete
+  in_progress
+  ready
+}
+
+"""
+Autogenerated return type of UpdateTask.
+"""
+type UpdateTaskPayload {
+  errors: [String!]!
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twenty-backend
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,27 +94,42 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.1'
 description: 'twenty: backend'
 email:
 - 0x1eef@protonmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- "./lib/twenty-backend.rb"
+- "./lib/twenty-backend/graphql.rb"
+- "./lib/twenty-backend/graphql/input.rb"
+- "./lib/twenty-backend/graphql/input/task_input.rb"
+- "./lib/twenty-backend/graphql/mutation.rb"
+- "./lib/twenty-backend/graphql/mutation/complete_task.rb"
+- "./lib/twenty-backend/graphql/mutation/create_task.rb"
+- "./lib/twenty-backend/graphql/mutation/destroy_task.rb"
+- "./lib/twenty-backend/graphql/mutation/set_random_project_color.rb"
+- "./lib/twenty-backend/graphql/mutation/update_task.rb"
+- "./lib/twenty-backend/graphql/schema.rb"
+- "./lib/twenty-backend/graphql/type.rb"
+- "./lib/twenty-backend/graphql/type/mutation.rb"
+- "./lib/twenty-backend/graphql/type/project.rb"
+- "./lib/twenty-backend/graphql/type/query.rb"
+- "./lib/twenty-backend/graphql/type/task.rb"
+- "./lib/twenty-backend/graphql/type/task_status.rb"
+- "./lib/twenty-backend/migration.rb"
+- "./lib/twenty-backend/migration/1_create_projects.rb"
+- "./lib/twenty-backend/migration/2_create_tasks.rb"
+- "./lib/twenty-backend/migration/3_add_color_to_projects.rb"
+- "./lib/twenty-backend/model.rb"
+- "./lib/twenty-backend/model/mixin/colorable_mixin.rb"
+- "./lib/twenty-backend/model/project.rb"
+- "./lib/twenty-backend/model/task.rb"
+- "./lib/twenty-backend/servlet.rb"
+- "./lib/twenty-backend/servlet/graphql.rb"
+- "./lib/twenty-backend/servlet/mixin/server_mixin.rb"
+- "./share/twenty-backend/schema.graphql"
 homepage: https://github.com/0x1eef/twenty#readme
 licenses:
 - 0BSD