Skip to content

Commit 1e7b5f1

Browse files
committed
Perform a 0.0.1 release
1 parent c526b39 commit 1e7b5f1

File tree

4 files changed

+60
-24
lines changed

4 files changed

+60
-24
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## [0.0.1] -
1+
## [0.0.1] - 2025-12-15
22

33
- Initial release
44

Gemfile.lock

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ PATH
22
remote: .
33
specs:
44
foobara-foobify-rails-app (0.0.1)
5-
foobara (>= 0.0.136, < 2.0.0)
5+
foobara (>= 0.3.0, < 2.0.0)
66

77
GEM
88
remote: https://rubygems.org/
@@ -17,7 +17,7 @@ GEM
1717
crack (1.0.1)
1818
bigdecimal
1919
rexml
20-
date (3.5.0)
20+
date (3.5.1)
2121
diff-lcs (1.6.2)
2222
docile (1.4.1)
2323
dotenv (3.2.0)
@@ -124,7 +124,7 @@ GEM
124124
foobara-typescript-remote-command-generator (1.2.0)
125125
foobara (>= 0.1.16, < 2.0.0)
126126
foobara-files-generator (< 2.0.0)
127-
foobara-util (1.0.4)
127+
foobara-util (1.0.6)
128128
formatador (1.2.3)
129129
reline
130130
guard (2.19.1)
@@ -145,12 +145,12 @@ GEM
145145
rspec (>= 2.99.0, < 4.0)
146146
hashdiff (1.2.1)
147147
inheritable-thread-vars (0.0.3)
148-
io-console (0.8.1)
148+
io-console (0.8.2)
149149
irb (1.15.3)
150150
pp (>= 0.6.0)
151151
rdoc (>= 4.0.0)
152152
reline (>= 0.4.2)
153-
json (2.17.1)
153+
json (2.18.0)
154154
language_server-protocol (3.17.0.5)
155155
lint_roller (1.1.0)
156156
listen (3.9.0)
@@ -178,7 +178,7 @@ GEM
178178
pry-byebug (3.11.0)
179179
byebug (~> 12.0)
180180
pry (>= 0.13, < 0.16)
181-
psych (5.2.6)
181+
psych (5.3.0)
182182
date
183183
stringio
184184
public_suffix (7.0.0)
@@ -188,7 +188,7 @@ GEM
188188
rb-fsevent (0.11.2)
189189
rb-inotify (0.11.1)
190190
ffi (~> 1.0)
191-
rdoc (6.16.1)
191+
rdoc (6.17.0)
192192
erb
193193
psych (>= 4.0.0)
194194
tsort

README.md

Lines changed: 51 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,70 @@
1-
#
2-
3-
TODO: Delete this and the text below, and describe your gem
4-
5-
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library
6-
into a gem. Put your Ruby code in the file `lib/foobara/empty_ruby_project_generator`. To experiment with that code,
7-
run `bin/console` for an interactive prompt.
1+
# FoobifyRailsApp
82

3+
This is a code generator for quickly wiring up foobara to an existing Rails application.
94

105
## Installation
116

12-
Typical stuff: add `gem "foobara-foobify-rails-app"` to your Gemfile or .gemspec file. Or even just
13-
`gem install foobara-foobify-rails-app` if just playing with it directly in scripts.
7+
Normally, you would just use this with `foob` so you would install `foob` however you would, such as
8+
adding `foob` to the `:development` section of your Gemfile or maybe even just `gem install foob`.
9+
10+
If you want to use this code generator outside of `foob` you can do the typical stuff like adding
11+
`gem "foobara-foobify-rails-app"` to your Gemfile or .gemspec file.
1412

1513
## Usage
1614

17-
TODO: Write usage instructions here
15+
### Using via `foob`
1816

19-
```ruby
20-
#!/usr/bin/env ruby
17+
You can see the options with `foob help foobify-rails-app` or `foob h foobify-rails-app`:
18+
19+
```
20+
$ foob help foobify-rails-app
21+
```
22+
23+
#### Using foobara as a service-object solution in an existing Rails application
24+
25+
You would only need to run it with:
26+
27+
```
28+
$ foob g foobify-rails-app
29+
```
2130

22-
require "foobara/load_dotenv"
23-
Foobara::LoadDotenv.run!(dir: __dir__)
31+
TODO: Finish this up once deployed and added to `foob`
32+
33+
If you're new to Foobara and want a sample command generated, you can run:
34+
35+
#### Exposing Foobara through the Rails router with foobara-rails-command-generator
36+
37+
If you want to expose your Foobara commands such that they can be used by external tools like
38+
code generators (to generate a TypeScript SDK, for example), MCP servers, etc, then run:
39+
40+
TODO
41+
42+
#### Letting ActiveRecord Models be used as if they were Foobara types
43+
44+
You can run:
45+
46+
This will allow you to use active record as types like so:
47+
48+
```ruby
49+
TODO
2450

25-
TODO: some example code
2651
```
52+
53+
You can do this without `foobara-active-record-type` and Foobara will still guarantee that what is
54+
passed in is an instance of that active record class. But with `foobara-active-record-type` you can
55+
get additional foobara-entity-like behaviors, such as automatically casting primary keys to records
56+
and being able to make use of the record attributes in code generators if, for example, you wanted
57+
to quickly generate a TypeScript React form as a starting point for working with your
58+
ActiveRecord class.
59+
2760
## Contributing
2861

2962
Bug reports and pull requests are welcome on GitHub
3063
at https://github.com/foobara/foobify-rails-app
3164

65+
You can find a contributing guide in the foobara monorepo here:
66+
https://github.com/foobara/foobara/blob/main/CONTRIBUTING.md
67+
3268
## License
3369

3470
This project is licensed under the MPL-2.0 license. Please see LICENSE.txt for more info.

foobara-foobify-rails-app.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
2323
"CHANGELOG.md"
2424
]
2525

26-
spec.add_dependency "foobara", ">= 0.0.136", "< 2.0.0"
26+
spec.add_dependency "foobara", ">= 0.3.0", "< 2.0.0"
2727

2828
spec.require_paths = ["lib"]
2929
spec.metadata["rubygems_mfa_required"] = "true"

0 commit comments

Comments
 (0)