Module: Tina4::AutoCrud

Defined in:
lib/tina4/auto_crud.rb

Class Method Summary collapse

Class Method Details

.build_example(model_class) ⇒ Object

Build a sample request body from ORM field definitions.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/tina4/auto_crud.rb', line 25

def build_example(model_class)
  example = {}
  return example unless model_class.respond_to?(:field_definitions)

  model_class.field_definitions.each do |name, opts|
    next if opts[:primary_key] && opts[:auto_increment]

    case opts[:type]
    when :integer
      example[name.to_s] = 0
    when :numeric, :float, :decimal
      example[name.to_s] = 0.0
    when :boolean
      example[name.to_s] = true
    when :datetime
      example[name.to_s] = "2024-01-01T00:00:00"
    else
      example[name.to_s] = "string"
    end
  end
  example
end

.clear! ⇒ Object Also known as: clear 



221
222
223
 
# File 'lib/tina4/auto_crud.rb', line 221

def clear!
  @models = []
end

.discover(models_dir = "src/orm", prefix: "/api") ⇒ Array<String>

Discover ORM model classes from a directory and register them.

Parameters:

  • models_dir (String) (defaults to: "src/orm") —

    directory to scan (default “src/orm”)

  • prefix (String) (defaults to: "/api") —

    URL prefix for generated routes (default “/api”)

Returns:

  • (Array<String>) —

    list of discovered model class names



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/tina4/auto_crud.rb', line 202

def discover(models_dir = "src/orm", prefix: "/api")
  discovered = []
  return discovered unless Dir.exist?(models_dir)

  Dir.glob(File.join(models_dir, "*.rb")).each do |file|
    require_relative File.expand_path(file)
  end

  # Find all ORM subclasses that have a table_name
  ObjectSpace.each_object(Class).select { |c| c < Tina4::ORM rescue false }.each do |klass|
    next unless klass.respond_to?(:table_name) && klass.table_name
    register(klass)
    discovered << klass.name
  end

  generate_routes(prefix: prefix) unless discovered.empty?
  discovered
end

.generate_routes(prefix: "/api") ⇒ Object

Generate REST endpoints for all registered models



18
19
20
21
22
 
# File 'lib/tina4/auto_crud.rb', line 18

def generate_routes(prefix: "/api")
  models.each do |model_class|
    generate_routes_for(model_class, prefix: prefix)
  end
end

.generate_routes_for(model_class, prefix: "/api") ⇒ Object

Generate REST endpoints for a single model class



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/tina4/auto_crud.rb', line 49

def generate_routes_for(model_class, prefix: "/api")
  table = model_class.table_name
  pk = model_class.primary_key_field || :id
  pretty_name = table.to_s.split("_").map(&:capitalize).join(" ")
  example_body = build_example(model_class)

  # GET /api/{table} -- list all with pagination, filtering, sorting
  Tina4::Router.add("GET", "#{prefix}/#{table}", proc { |req, res|
    begin
      per_page = (req.query["per_page"] || req.query["limit"] || 10).to_i
      page     = (req.query["page"] || 1).to_i
      limit    = per_page
      offset   = req.query["offset"] ? req.query["offset"].to_i : (page - 1) * per_page
      order_by = parse_sort(req.query["sort"])

      # Filter support: ?filter[field]=value
      filter_conditions = []
      filter_values = []
      req.query.each do |key, value|
        if key =~ /\Afilter\[(\w+)\]\z/
          filter_conditions << "#{$1} = ?"
          filter_values << value
        end
      end

      if filter_conditions.empty?
        records = model_class.all(limit: limit, offset: offset, order_by: order_by)
        total = model_class.count
      else
        where_clause = filter_conditions.join(" AND ")
        records = model_class.where(where_clause, filter_values)
        total = records.length
        # Apply manual pagination for filtered results
        records = records.slice(offset, limit) || []
      end

      res.json({
        data: records.map { |r| r.to_h },
        total: total,
        limit: limit,
        offset: offset
      })
    rescue => e
      res.json({ error: e.message }, status: 500)
    end
  }, swagger_meta: { summary: "List all #{pretty_name}", tags: [table.to_s] })

  # GET /api/{table}/{id} -- get single record
  Tina4::Router.add("GET", "#{prefix}/#{table}/{id}", proc { |req, res|
    begin
      id = req.params["id"]
      record = model_class.find_by_id(id.to_i)
      if record
        res.json({ data: record.to_h })
      else
        res.json({ error: "Not found" }, status: 404)
      end
    rescue => e
      res.json({ error: e.message }, status: 500)
    end
  }, swagger_meta: { summary: "Get #{pretty_name} by ID", tags: [table.to_s] })

  # POST /api/{table} -- create record
  Tina4::Router.add("POST", "#{prefix}/#{table}", proc { |req, res|
    begin
      attributes = req.body_parsed
      record = model_class.create(attributes)
      if record.persisted?
        res.json({ data: record.to_h }, status: 201)
      else
        res.json({ errors: record.errors }, status: 422)
      end
    rescue => e
      res.json({ error: e.message }, status: 500)
    end
  }, swagger_meta: {
    summary: "Create #{pretty_name}",
    tags: [table.to_s],
    request_body: {
      "description" => "#{pretty_name} data",
      "required" => true,
      "content" => {
        "application/json" => {
          "schema" => { "type" => "object" },
          "example" => example_body
        }
      }
    }
  })

  # PUT /api/{table}/{id} -- update record
  Tina4::Router.add("PUT", "#{prefix}/#{table}/{id}", proc { |req, res|
    begin
      id = req.params["id"]
      record = model_class.find_by_id(id.to_i)
      unless record
        next res.json({ error: "Not found" }, status: 404)
      end

      attributes = req.body_parsed
      attributes.each do |key, value|
        setter = "#{key}="
        record.__send__(setter, value) if record.respond_to?(setter)
      end

      if record.save
        res.json({ data: record.to_h })
      else
        res.json({ errors: record.errors }, status: 422)
      end
    rescue => e
      res.json({ error: e.message }, status: 500)
    end
  }, swagger_meta: {
    summary: "Update #{pretty_name}",
    tags: [table.to_s],
    request_body: {
      "description" => "#{pretty_name} data",
      "required" => true,
      "content" => {
        "application/json" => {
          "schema" => { "type" => "object" },
          "example" => example_body
        }
      }
    }
  })

  # DELETE /api/{table}/{id} -- delete record
  Tina4::Router.add("DELETE", "#{prefix}/#{table}/{id}", proc { |req, res|
    begin
      id = req.params["id"]
      record = model_class.find_by_id(id.to_i)
      unless record
        next res.json({ error: "Not found" }, status: 404)
      end

      if record.delete
        res.json({ message: "Deleted" })
      else
        res.json({ error: "Delete failed" }, status: 500)
      end
    rescue => e
      res.json({ error: e.message }, status: 500)
    end
  }, swagger_meta: { summary: "Delete #{pretty_name}", tags: [table.to_s] })
end

.models ⇒ Object

Track registered model classes



8
9
10
 
# File 'lib/tina4/auto_crud.rb', line 8

def models
  @models ||= []
end

.register(model_class) ⇒ Object

Register a model for auto-CRUD



13
14
15
 
# File 'lib/tina4/auto_crud.rb', line 13

def register(model_class)
  models << model_class unless models.include?(model_class)
end