Sweep: Add two numbers

[taherv]

Create a new file add.go
Add a function that adds two numbers, and returns the sum as a result.

Checklist

• add.go ✅ Commit d50fb25

[puresweep2]

Here's the PR! #8.

💎 Sweep Pro: I'm creating this ticket using GPT-4. You have unlimited GPT-4 tickets.

---

Actions (click)

• ↻ Restart Sweep

Install Sweep Configs: Pull Request

---

Step 1: 🔎 Searching

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I looked at (click to expand). If some file is missing from here, you can mention the path in the ticket description.

embedmd/README.md

Lines 35 to 151 in 97c13d6

	Omitting the the second regular expression will embed only the piece of text
	that matches `/regexp/`:
	```Markdown
	[embedmd]:# (pathOrURL language /regexp/)
	```
	To embed the whole line matching a regular expression you can use:
	```Markdown
	[embedmd]:# (pathOrURL language /.*regexp.*/)
	```
	To embed from a point to the end you should use:
	```Markdown
	[embedmd]:# (pathOrURL language /start regexp/ $)
	```
	To embed a whole file, omit both regular expressions:
	```Markdown
	[embedmd]:# (pathOrURL language)
	```
	You can omit the language in any of the previous commands, and the extension
	of the file will be used for the snippet syntax highlighting.
	This works when the file extensions matches the name of the language (like Go
	files, since `.go` matches `go`). However, this will fail with other files like
	`.md` whose language name is `markdown`.
	```Markdown
	[embedmd]:# (file.ext)
	```
	## Installation
	> You can install Go by following [these instructions](https://golang.org/doc/install).
	`embedmd` is written in Go, so if you have Go installed you can install it with
	`go get`:
	```
	go get github.com/campoy/embedmd
	```
	This will download the code, compile it, and leave an `embedmd` binary
	in `$GOPATH/bin`.
	Eventually, and if there's enough interest, I will provide binaries for
	every OS and architecture out there ... _eventually_.
	## Usage:
	Given the two files in [sample](sample):
	*hello.go:*
	[embedmd]:# (sample/hello.go)
	```go
	// Copyright 2016 Google Inc. All rights reserved.
	// Use of this source code is governed by the Apache 2.0
	// license that can be found in the LICENSE file.
	package main
	import (
	"fmt"
	"time"
	)
	func main() {
	fmt.Println("Hello, there, it is", time.Now())
	}
	```
	*docs.md:*
	[embedmd]:# (sample/docs.md Markdown /./ /embedmd.*time.*/)
	```Markdown
	# A hello world in Go
	Go is very simple, here you can see a whole "hello, world" program.
	[embedmd]:# (hello.go)
	We can try to embed a file from a directory.
	[embedmd]:# (test/hello.go /func main/ $)
	You always start with a `package` statement like:
	[embedmd]:# (hello.go /package.*/)
	Followed by an `import` statement:
	[embedmd]:# (hello.go /import/ /\)/)
	You can also see how to get the current time:
	[embedmd]:# (hello.go /time\.[^)]*\)/)
	```
	# Flags
	* `-w`: Executing `embedmd -w docs.md` will modify `docs.md`
	and add the corresponding code snippets, as shown in
	[sample/result.md](sample/result.md).
	* `-d`: Executing `embedmd -d docs.md` will display the difference
	between the contents of `docs.md` and the output of
	`embedmd docs.md`.
	### Disclaimer
	This is not an official Google product (experimental or otherwise), it is just

embedmd/LICENSE

Lines 1 to 201 in 97c13d6

	Apache License
	Version 2.0, January 2004
	http://www.apache.org/licenses/
	TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
	1. Definitions.
	"License" shall mean the terms and conditions for use, reproduction,
	and distribution as defined by Sections 1 through 9 of this document.
	"Licensor" shall mean the copyright owner or entity authorized by
	the copyright owner that is granting the License.
	"Legal Entity" shall mean the union of the acting entity and all
	other entities that control, are controlled by, or are under common
	control with that entity. For the purposes of this definition,
	"control" means (i) the power, direct or indirect, to cause the
	direction or management of such entity, whether by contract or
	otherwise, or (ii) ownership of fifty percent (50%) or more of the
	outstanding shares, or (iii) beneficial ownership of such entity.
	"You" (or "Your") shall mean an individual or Legal Entity
	exercising permissions granted by this License.
	"Source" form shall mean the preferred form for making modifications,
	including but not limited to software source code, documentation
	source, and configuration files.
	"Object" form shall mean any form resulting from mechanical
	transformation or translation of a Source form, including but
	not limited to compiled object code, generated documentation,
	and conversions to other media types.
	"Work" shall mean the work of authorship, whether in Source or
	Object form, made available under the License, as indicated by a
	copyright notice that is included in or attached to the work
	(an example is provided in the Appendix below).
	"Derivative Works" shall mean any work, whether in Source or Object
	form, that is based on (or derived from) the Work and for which the
	editorial revisions, annotations, elaborations, or other modifications
	represent, as a whole, an original work of authorship. For the purposes
	of this License, Derivative Works shall not include works that remain
	separable from, or merely link (or bind by name) to the interfaces of,
	the Work and Derivative Works thereof.
	"Contribution" shall mean any work of authorship, including
	the original version of the Work and any modifications or additions
	to that Work or Derivative Works thereof, that is intentionally
	submitted to Licensor for inclusion in the Work by the copyright owner
	or by an individual or Legal Entity authorized to submit on behalf of
	the copyright owner. For the purposes of this definition, "submitted"
	means any form of electronic, verbal, or written communication sent
	to the Licensor or its representatives, including but not limited to
	communication on electronic mailing lists, source code control systems,
	and issue tracking systems that are managed by, or on behalf of, the
	Licensor for the purpose of discussing and improving the Work, but
	excluding communication that is conspicuously marked or otherwise
	designated in writing by the copyright owner as "Not a Contribution."
	"Contributor" shall mean Licensor and any individual or Legal Entity
	on behalf of whom a Contribution has been received by Licensor and
	subsequently incorporated within the Work.
	2. Grant of Copyright License. Subject to the terms and conditions of
	this License, each Contributor hereby grants to You a perpetual,
	worldwide, non-exclusive, no-charge, royalty-free, irrevocable
	copyright license to reproduce, prepare Derivative Works of,
	publicly display, publicly perform, sublicense, and distribute the
	Work and such Derivative Works in Source or Object form.
	3. Grant of Patent License. Subject to the terms and conditions of
	this License, each Contributor hereby grants to You a perpetual,
	worldwide, non-exclusive, no-charge, royalty-free, irrevocable
	(except as stated in this section) patent license to make, have made,
	use, offer to sell, sell, import, and otherwise transfer the Work,
	where such license applies only to those patent claims licensable
	by such Contributor that are necessarily infringed by their
	Contribution(s) alone or by combination of their Contribution(s)
	with the Work to which such Contribution(s) was submitted. If You
	institute patent litigation against any entity (including a
	cross-claim or counterclaim in a lawsuit) alleging that the Work
	or a Contribution incorporated within the Work constitutes direct
	or contributory patent infringement, then any patent licenses
	granted to You under this License for that Work shall terminate
	as of the date such litigation is filed.
	4. Redistribution. You may reproduce and distribute copies of the
	Work or Derivative Works thereof in any medium, with or without
	modifications, and in Source or Object form, provided that You
	meet the following conditions:
	(a) You must give any other recipients of the Work or
	Derivative Works a copy of this License; and
	(b) You must cause any modified files to carry prominent notices
	stating that You changed the files; and
	(c) You must retain, in the Source form of any Derivative Works
	that You distribute, all copyright, patent, trademark, and
	attribution notices from the Source form of the Work,
	excluding those notices that do not pertain to any part of
	the Derivative Works; and
	(d) If the Work includes a "NOTICE" text file as part of its
	distribution, then any Derivative Works that You distribute must
	include a readable copy of the attribution notices contained
	within such NOTICE file, excluding those notices that do not
	pertain to any part of the Derivative Works, in at least one
	of the following places: within a NOTICE text file distributed
	as part of the Derivative Works; within the Source form or
	documentation, if provided along with the Derivative Works; or,
	within a display generated by the Derivative Works, if and
	wherever such third-party notices normally appear. The contents
	of the NOTICE file are for informational purposes only and
	do not modify the License. You may add Your own attribution
	notices within Derivative Works that You distribute, alongside
	or as an addendum to the NOTICE text from the Work, provided
	that such additional attribution notices cannot be construed
	as modifying the License.
	You may add Your own copyright statement to Your modifications and
	may provide additional or different license terms and conditions
	for use, reproduction, or distribution of Your modifications, or
	for any such Derivative Works as a whole, provided Your use,
	reproduction, and distribution of the Work otherwise complies with
	the conditions stated in this License.
	5. Submission of Contributions. Unless You explicitly state otherwise,
	any Contribution intentionally submitted for inclusion in the Work
	by You to the Licensor shall be under the terms and conditions of
	this License, without any additional terms or conditions.
	Notwithstanding the above, nothing herein shall supersede or modify
	the terms of any separate license agreement you may have executed
	with Licensor regarding such Contributions.
	6. Trademarks. This License does not grant permission to use the trade
	names, trademarks, service marks, or product names of the Licensor,
	except as required for reasonable and customary use in describing the
	origin of the Work and reproducing the content of the NOTICE file.
	7. Disclaimer of Warranty. Unless required by applicable law or
	agreed to in writing, Licensor provides the Work (and each
	Contributor provides its Contributions) on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
	implied, including, without limitation, any warranties or conditions
	of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
	PARTICULAR PURPOSE. You are solely responsible for determining the
	appropriateness of using or redistributing the Work and assume any
	risks associated with Your exercise of permissions under this License.
	8. Limitation of Liability. In no event and under no legal theory,
	whether in tort (including negligence), contract, or otherwise,
	unless required by applicable law (such as deliberate and grossly
	negligent acts) or agreed to in writing, shall any Contributor be
	liable to You for damages, including any direct, indirect, special,
	incidental, or consequential damages of any character arising as a
	result of this License or out of the use or inability to use the
	Work (including but not limited to damages for loss of goodwill,
	work stoppage, computer failure or malfunction, or any and all
	other commercial damages or losses), even if such Contributor
	has been advised of the possibility of such damages.
	9. Accepting Warranty or Additional Liability. While redistributing
	the Work or Derivative Works thereof, You may choose to offer,
	and charge a fee for, acceptance of support, warranty, indemnity,
	or other liability obligations and/or rights consistent with this
	License. However, in accepting such obligations, You may act only
	on Your own behalf and on Your sole responsibility, not on behalf
	of any other Contributor, and only if You agree to indemnify,
	defend, and hold each Contributor harmless for any liability
	incurred by, or claims asserted against, such Contributor by reason
	of your accepting any such warranty or additional liability.
	END OF TERMS AND CONDITIONS
	APPENDIX: How to apply the Apache License to your work.
	To apply the Apache License to your work, attach the following
	boilerplate notice, with the fields enclosed by brackets "{}"
	replaced with your own identifying information. (Don't include
	the brackets!) The text should be enclosed in the appropriate
	comment syntax for the file format. We also recommend that a
	file or class name and description of purpose be included on the
	same "printed page" as the copyright notice for easier
	identification within third-party archives.
	Copyright {yyyy} {name of copyright owner}
	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at
	http://www.apache.org/licenses/LICENSE-2.0
	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.

embedmd/main_test.go

Lines 59 to 158 in 97c13d6

	},
	}
	defer func(r io.Reader, w io.Writer) { stdin, stdout = r, w }(stdin, stdout)
	for _, tt := range tc {
	stdin = strings.NewReader(tt.in)
	buf := &bytes.Buffer{}
	stdout = buf
	foundDiff, err := embed(nil, tt.w, tt.d)
	if !eqErr(t, tt.name, err, tt.err) {
	continue
	}
	if got := buf.String(); tt.out != got {
	t.Errorf("case [%s] expected output\n%q\n; got\n%q", tt.name, tt.out, got)
	}
	if tt.d && foundDiff != tt.foundDiff {
	if foundDiff {
	t.Errorf("case [%s] expected to find a diff, but didn't", tt.name)
	} else {
	t.Errorf("case [%s] didn't expect to find a diff, but did", tt.name)
	}
	}
	}
	}
	func TestEmbedFiles(t *testing.T) {
	tc := []struct {
	name string
	in string
	out string
	err string
	d, w bool
	}{
	{name: "rewriting a single file",
	in: "one\ntwo\nthree",
	w: true,
	out: "one\ntwo\nthree\n",
	},
	{name: "diffing a single file",
	in: "one\ntwo\nthree",
	d: true,
	out: "@@ -1 +1,4 @@\n+one\n+two\n+three\n \n",
	},
	}
	defer func(f func(string) (file, error)) { openFile = f }(openFile)
	for _, tt := range tc {
	f := newFakeFile(tt.in)
	openFile = func(path string) (file, error) { return f, nil }
	stdout = os.Stdout
	if tt.d {
	stdout = &f.buf
	}
	_, err := embed([]string{"docs.md"}, tt.w, tt.d)
	if !eqErr(t, tt.name, err, tt.err) {
	continue
	}
	if got := f.buf.String(); tt.out != got {
	t.Errorf("case [%s]: expected output \n%q; got\n%q", tt.name, tt.out, got)
	}
	}
	}
	func eqErr(t *testing.T, id string, err error, msg string) bool {
	if err == nil && msg == "" {
	return true
	}
	if err == nil && msg != "" {
	t.Errorf("case [%s]: expected error message %q; but got nothing", id, msg)
	return false
	}
	if err != nil && msg != err.Error() {
	t.Errorf("case [%s]: expected error message %q; but got %q", id, msg, err)
	}
	return false
	}
	type fakeFile struct {
	io.ReadCloser
	buf bytes.Buffer
	}
	func (f *fakeFile) WriteAt(b []byte, offset int64) (int, error) { return f.buf.Write(b) }
	func (f *fakeFile) Truncate(int64) error { return nil }
	func newFakeFile(s string) *fakeFile {
	return &fakeFile{ReadCloser: ioutil.NopCloser(strings.NewReader(s))}
	}
	func newOpenFunc(files map[string]string) func(string) (file, error) {
	return func(path string) (file, error) {
	if s, ok := files[path]; ok {
	return newFakeFile(s), nil
	}
	return nil, os.ErrNotExist
	}

embedmd/sample/result.md

Lines 1 to 68 in 97c13d6

	# A hello world in Go
	Go is very simple, here you can see a whole "hello, world" program.
	[embedmd]:# (hello.go)
	```go
	// Copyright 2016 Google Inc. All rights reserved.
	// Use of this source code is governed by the Apache 2.0
	// license that can be found in the LICENSE file.
	package main
	import (
	"fmt"
	"time"
	)
	func main() {
	fmt.Println("Hello, there, it is", time.Now())
	}
	```
	We can try to embed a file from a directory.
	[embedmd]:# (test/hello.go /func main/ $)
	```go
	func main() {
	fmt.Println("Hello, there, it is", time.Now())
	}
	```
	You always start with a `package` statement like:
	[embedmd]:# (hello.go /package.*/)
	```go
	package main
	```
	Followed by an `import` statement:
	[embedmd]:# (hello.go /import/ /\)/)
	```go
	import (
	"fmt"
	"time"
	)
	```
	You can also see how to get the current time:
	[embedmd]:# (hello.go /time\.[^)]*\)/)
	```go
	time.Now()
	```
	You can also have some extra code independent from `embedmd`
	```python
	print 'hello'
	```
	And why not include some file directly from GitHub?
	[embedmd]:# (https://raw.githubusercontent.com/campoy/embedmd/master/sample/hello.go /func main/ $)
	```go
	func main() {
	fmt.Println("Hello, there, it is", time.Now())
	}

embedmd/embedmd/parser_test.go

Lines 1 to 104 in 97c13d6

	// Copyright 2016 Google Inc. All rights reserved.
	// Licensed under the Apache License, Version 2.0 (the "License");
	// you may not use this file except in compliance with the License.
	// You may obtain a copy of the License at
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to writing, software distributed
	// under the License is distributed on a "AS IS" BASIS, WITHOUT WARRANTIES OR
	// CONDITIONS OF ANY KIND, either express or implied.
	//
	// See the License for the specific language governing permissions and
	// limitations under the License.
	package embedmd
	import (
	"bytes"
	"fmt"
	"io"
	"strings"
	"testing"
	)
	func TestParser(t *testing.T) {
	tc := []struct {
	name string
	in string
	out string
	run commandRunner
	err string
	}{
	{
	name: "empty file",
	in: "",
	out: "",
	},
	{
	name: "just text",
	in: "one\ntwo\nthree\n",
	out: "one\ntwo\nthree\n",
	},
	{
	name: "a command",
	in: "one\n[embedmd]:# (code.go)",
	out: "one\n[embedmd]:# (code.go)\nOK\n",
	run: func(w io.Writer, cmd *command) error {
	if cmd.path != "code.go" {
	return fmt.Errorf("bad command")
	}
	fmt.Fprint(w, "OK\n")
	return nil
	},
	},
	{
	name: "a command then some text",
	in: "one\n[embedmd]:# (code.go)\nYay\n",
	out: "one\n[embedmd]:# (code.go)\nOK\nYay\n",
	run: func(w io.Writer, cmd *command) error {
	if cmd.path != "code.go" {
	return fmt.Errorf("bad command")
	}
	fmt.Fprint(w, "OK\n")
	return nil
	},
	},
	{
	name: "a bad command",
	in: "one\n[embedmd]:# (code\n",
	err: "2: argument list should be in parenthesis",
	},
	{
	name: "an ignored command",
	in: "one\n```\n[embedmd]:# (code.go)\n```\n",
	out: "one\n```\n[embedmd]:# (code.go)\n```\n",
	},
	{
	name: "unbalanced code section",
	in: "one\n```\nsome code\n",
	err: "3: unbalanced code section",
	},
	{
	name: "two contiguous code sections",
	in: "\n```go\nhello\n```\n```go\nbye\n```\n",
	out: "\n```go\nhello\n```\n```go\nbye\n```\n",
	},
	{
	name: "two non contiguous code sections",
	in: "```go\nhello\n```\n\n```go\nbye\n```\n",
	out: "```go\nhello\n```\n\n```go\nbye\n```\n",
	},
	}
	for _, tt := range tc {
	t.Run(tt.name, func(t *testing.T) {
	var out bytes.Buffer
	err := process(&out, strings.NewReader(tt.in), tt.run)
	if !eqErr(t, tt.name, err, tt.err) {
	return
	}
	if got := out.String(); got != tt.out {
	t.Errorf("case [%s] expected %q; got %q", tt.name, tt.out, got)
	}
	})
	}

---

Step 2: ⌨️ Coding

• add.go ✅ Commit d50fb25

• Create a new file named `add.go` in the root directory of the repository.
• At the top of the file, add the package declaration `package main`.
• Below the package declaration, define a new function `addNumbers` that takes two integer parameters and returns their sum. The function should look like this: ```go func addNumbers(a int, b int) int { return a + b } ```

---

---

Step 3: 🔁 Code Review

I have finished reviewing the code for completeness. I did not find errors for sweep/add-function.

.

---

🎉 Latest improvements to Sweep:

• Sweep can now passively improve your repository! Check out Rules to learn more.

---

💡 To recreate the pull request edit the issue title or description. To tweak the pull request, leave a comment on the pull request.
^{Join Our Discord}